mt_metadata.transfer_functions.io.jfiles.jfile
==============================================

.. py:module:: mt_metadata.transfer_functions.io.jfiles.jfile

.. autoapi-nested-parse::

   .. py:module:: JFile
       :synopsis: Deal with J-Files of the format propsed by Alan Jones

   .. codeauthor:: Jared Peacock <jpeacock@usgs.gov>



Classes
-------

.. autoapisummary::

   mt_metadata.transfer_functions.io.jfiles.jfile.JFile


Module Contents
---------------

.. py:class:: JFile(fn = None, **kwargs)

   be able to read and write a j-file


   .. py:attribute:: header


   .. py:property:: fn


   .. py:attribute:: z
      :value: None



   .. py:attribute:: z_err
      :value: None



   .. py:attribute:: t
      :value: None



   .. py:attribute:: t_err
      :value: None



   .. py:attribute:: frequency
      :value: None



   .. py:property:: periods
      :type: None | numpy.typing.NDArray[numpy.float64]



   .. py:method:: read(fn = None, get_elevation=False)

      Read data from a j file

      :param fn: full path to j-file to read, defaults to None
      :type fn: str | Path | None
      :param get_elevation: if True, will try to get elevation from the NM elevation service,
                            defaults to False
      :type get_elevation: bool, optional

      :raises ValueError: If the file is not found or cannot be opened.
      :raises NameError: If the file is not a valid j-file.

      :returns: Reads the data into the instance variables.
      :rtype: None



   .. py:property:: station_metadata


   .. py:property:: survey_metadata