mt_metadata.timeseries.stationxml
=================================

.. py:module:: mt_metadata.timeseries.stationxml

.. autoapi-nested-parse::

   Tools to translate StationXML to MT Metadata



Submodules
----------

.. toctree::
   :maxdepth: 1

   /source/api/mt_metadata/timeseries/stationxml/fdsn_tools/index
   /source/api/mt_metadata/timeseries/stationxml/utils/index
   /source/api/mt_metadata/timeseries/stationxml/xml_channel_mt_channel/index
   /source/api/mt_metadata/timeseries/stationxml/xml_equipment_mt_run/index
   /source/api/mt_metadata/timeseries/stationxml/xml_inventory_mt_experiment/index
   /source/api/mt_metadata/timeseries/stationxml/xml_network_mt_survey/index
   /source/api/mt_metadata/timeseries/stationxml/xml_station_mt_station/index


Classes
-------

.. autoapisummary::

   mt_metadata.timeseries.stationxml.XMLNetworkMTSurvey
   mt_metadata.timeseries.stationxml.XMLEquipmentMTRun
   mt_metadata.timeseries.stationxml.XMLChannelMTChannel
   mt_metadata.timeseries.stationxml.XMLInventoryMTExperiment


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

.. py:class:: XMLNetworkMTSurvey

   Bases: :py:obj:`mt_metadata.timeseries.stationxml.utils.BaseTranslator`


   translate back and forth between StationXML Network and MT Survey


   .. py:attribute:: mt_translator


   .. py:attribute:: mt_comments_list
      :value: ['country', 'geographic_name', 'citation_journal.doi', 'id', 'project', 'acquired_by.author',...



   .. py:method:: xml_to_mt(network)

      Translate a StationXML Network object to MT Survey object

      :param network: StationXML network element
      :type network: :class:`obspy.core.inventory.Network`




   .. py:method:: mt_to_xml(survey, code='ZU')

      Convert MT Survey to Obspy Network

      .. note:: For now the default code is ZU which is an IRIS catch-all network




.. py:class:: XMLEquipmentMTRun

   Bases: :py:obj:`mt_metadata.timeseries.stationxml.utils.BaseTranslator`


   translate back and forth between StationXML Station and MT Station


   .. py:attribute:: xml_translator


   .. py:attribute:: mt_translator


   .. py:attribute:: mt_comments_list


   .. py:attribute:: mt_description_list
      :value: ['data_logger.firmware.author', 'data_logger.firmware.name', 'data_logger.firmware.version',...



   .. py:method:: xml_to_mt(equipment)

      Read in an equipment block.

      :param equipment: an Equipment element
      :type equipment: :class:`obspy.core.inventory.Equipment`




   .. py:method:: mt_to_xml(mt_run)

      Convert an :class:mt_metadata.timeseries.Run` to XML equipment and comments

      :param mt_run: DESCRIPTION
      :type mt_run: TYPE
      :return: DESCRIPTION
      :rtype: TYPE




.. py:class:: XMLChannelMTChannel

   Bases: :py:obj:`mt_metadata.timeseries.stationxml.utils.BaseTranslator`


   translate back and forth between StationXML Channel and MT Channel


   .. py:attribute:: understood_sensor_types
      :value: ['logger', 'magnetometer', 'induction coil', 'coil', 'dipole', 'electrode']



   .. py:attribute:: mt_translator


   .. py:attribute:: mt_comments_list
      :value: ['run.id']



   .. py:attribute:: run_list
      :value: None



   .. py:method:: xml_to_mt(xml_channel, existing_filters={})

      Translate :class:`obspy.core.inventory.Channel` to
      :class:`mt_metadata.timeseries.Channel`

      :param xml_channel: Obspy Channel object
      :type xml_channel: :class:`obspy.core.inventory.Channel`
      :returns: MT Channel
      :rtype: :class:`mt_metadata.timeseries.Channel`




   .. py:method:: mt_to_xml(mt_channel, filters_dict, hard_code=True)

      Translate :class:`mt_metadata.timeseries.Channel` to
      :class:`obspy.core.inventory.Channel`


      :param xml_channel: MT Channel object
      :type xml_channel: :class:`mt_metadata.timeseries.Channel`
      :returns: MT Channel
      :rtype: :class:`obspy.core.inventory.Channel`




.. py:class:: XMLInventoryMTExperiment

   Read the full files and put the elements in the appropriate locations.



   .. py:attribute:: logger


   .. py:attribute:: network_translator


   .. py:attribute:: station_translator


   .. py:attribute:: channel_translator


   .. py:method:: xml_to_mt(inventory_object=None, stationxml_fn=None, mt_fn=None)

      Read in a StationXML using Obspy :class:`obspy.core.inventory.Inventory`
      and convert to an MT :class:`mt_metadata.timeseries.Experiment`


      :param inventory_object: inventory object or StationXML file name
      :type inventory_object: :class:`obspy.core.inventory.Inventory`
      :param stationxml_fn: full path to StationXML file
      :type stationxml_fn: Path or string
      :param mt_fn: full path to MT file
      :type mt_fn: Path or string

      :return: DESCRIPTION
      :rtype: TYPE




   .. py:method:: mt_to_xml(mt_experiment, mt_fn=None, stationxml_fn=None, ns_dict=None)

      Convert from MT :class:`mt_metadata.timeseries.Experiment` to
      :class:`obspy.core.inventory.Inventory`

      :param mt_experiment: DESCRIPTION
      :type mt_experiment: TYPE
      :param mt_fn: DESCRIPTION, defaults to None
      :type mt_fn: TYPE, optional
      :param stationxml_fn: DESCRIPTION, defaults to None
      :type stationxml_fn: TYPE, optional
      :param ns_dict: DESCRIPTION, defaults to None
      :type ns_dict: TYPE, optional
      :raises ValueError: DESCRIPTION
      :return: DESCRIPTION
      :rtype: TYPE




   .. py:method:: add_run(xml_station, mt_run, filters_dict)

      Check to see if channel information already exists in the channel list of
      an xml station.

      .. todo:: Need to make sure the times are updated

      :param xml_station: DESCRIPTION
      :type xml_station: TYPE
      :param xml_channel: DESCRIPTION
      :type xml_channel: TYPE
      :return: DESCRIPTION
      :rtype: TYPE




   .. py:method:: compare_xml_channel(xml_channel_01, xml_channel_02)

      Compare xml channels to see if a new epoch needs to be made or not.

      :param xml_channel_01: DESCRIPTION
      :type xml_channel_01: TYPE
      :param xml_channel_02: DESCRIPTION
      :type xml_channel_02: TYPE
      :return: DESCRIPTION
      :rtype: TYPE