mt_metadata.transfer_functions.io.zonge
=======================================

.. py:module:: mt_metadata.transfer_functions.io.zonge


Submodules
----------

.. toctree::
   :maxdepth: 1

   /source/api/mt_metadata/transfer_functions/io/zonge/metadata/index
   /source/api/mt_metadata/transfer_functions/io/zonge/zonge/index


Classes
-------

.. autoapisummary::

   mt_metadata.transfer_functions.io.zonge.ZongeMTAvg


Package Contents
----------------

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

   deal with avg files output from mtedit


   .. py:attribute:: header


   .. py:attribute:: info_keys
      :value: ['skip', 'frequency', 'e_magnitude', 'b_magnitude', 'z_magnitude', 'z_phase',...



   .. py:attribute:: info_fmt
      :value: []



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



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



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



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



   .. py:attribute:: components
      :value: []



   .. py:attribute:: freq_index_dict
      :value: None



   .. py:attribute:: z_positive
      :value: 'down'



   .. py:property:: fn
      :type: pathlib.Path | None



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

      Read data from a file into the object as a pandas DataFrame

      :param fn: The file name to read from, by default None
      :type fn: str | Path | None, optional
      :param get_elevation: Whether to get elevation data, by default False
      :type get_elevation: bool, optional



   .. py:method:: to_complex(zmag, zphase)

      Convert magnitude and phase to complex representation.

      Outputs of mtedit are magnitude and phase of z, convert to real and
      imaginary parts, phase is in milliradians.

      :param zmag: The magnitude array.
      :type zmag: np.typing.NDArray
      :param zphase: The phase array.
      :type zphase: np.typing.NDArray

      :returns: The real and imaginary parts of the complex representation.
      :rtype: tuple[np.typing.NDArray, np.typing.NDArray]



   .. py:method:: to_amp_phase(zreal, zimag)

      Convert to amplitude and phase from real and imaginary

      :param zreal: The real part of the complex representation.
      :type zreal: np.typing.NDArray
      :param zimag: The imaginary part of the complex representation.
      :type zimag: np.typing.NDArray

      :returns: The amplitude and phase representation.
      :rtype: tuple[np.typing.NDArray, np.typing.NDArray]



   .. py:property:: run_metadata
      :type: mt_metadata.timeseries.Run



   .. py:property:: ex_metadata
      :type: mt_metadata.timeseries.Electric



   .. py:property:: ey_metadata
      :type: mt_metadata.timeseries.Electric



   .. py:property:: hx_metadata
      :type: mt_metadata.timeseries.Magnetic



   .. py:property:: hy_metadata
      :type: mt_metadata.timeseries.Magnetic



   .. py:property:: hz_metadata
      :type: mt_metadata.timeseries.Magnetic



   .. py:property:: station_metadata
      :type: mt_metadata.transfer_functions.tf.Station



   .. py:property:: survey_metadata
      :type: mt_metadata.timeseries.Survey



   .. py:method:: write(fn)

      Write an .avg file

      :param fn: Filename to write to
      :type fn: str or Path