mt_metadata.timeseries.tools
============================

.. py:module:: mt_metadata.timeseries.tools


Submodules
----------

.. toctree::
   :maxdepth: 1

   /source/api/mt_metadata/timeseries/tools/from_many_mt_files/index


Classes
-------

.. autoapisummary::

   mt_metadata.timeseries.tools.MT2StationXML


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

.. py:class:: MT2StationXML(xml_path=None)

   Bases: :py:obj:`mt_metadata.timeseries.stationxml.XMLInventoryMTExperiment`


   A class to convert multiple MT xml files into a stationXML (MTML)

   This is for a use case of A. Kelbert who places each level of metadata
   into a single XML file.  This class collects all those files and puts
   them into the proper order.

   She has the files named as follows

   survey.xml               --> Survey metadata `mt_metadata.timeseries.Survey`
   filters.xml              --> All filters
   station.xml              --> Station metadata `mt_metadata.timeseries.Station`
   station.run.xml          --> Run metadata `mt_metadata.timeseries.Run`
   station.run.channel.xml  --> Channel metadata `mt_metadata.timeseries.Channel`




   .. py:property:: xml_path


   .. py:method:: has_xml_path()


   .. py:method:: is_a_filter_xml(fn)
      :staticmethod:



   .. py:method:: is_a_survey_xml(fn)
      :staticmethod:



   .. py:method:: is_a_station_xml(fn)
      :staticmethod:



   .. py:method:: is_a_run_xml(fn)
      :staticmethod:



   .. py:method:: is_a_channel_xml(fn)
      :staticmethod:



   .. py:method:: get_xml_files()

      Get all mtml xml files for a given station.



   .. py:method:: make_df()

      Make a pandas data frame for easier querying

      :return: DESCRIPTION
      :rtype: TYPE




   .. py:property:: stations


   .. py:property:: survey


   .. py:property:: filters


   .. py:method:: sort_by_station(stations=None)

      sort the file into station, runs and channels

      :return: DESCRIPTION
      :rtype: TYPE




   .. py:method:: read_xml_file(xml_file)
      :staticmethod:


      read an xml file an return an xml element

      :param xml_file: DESCRIPTION
      :type xml_file: TYPE
      :return: DESCRIPTION
      :rtype: TYPE




   .. py:method:: make_experiment(stations=None)

      Create an MTML experiment from the a directory of xml files
      :return: DESCRIPTION
      :rtype: TYPE




   .. py:method:: get_mt_channel(ch_fn, filters_fn)

      have a look at an mt channel