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

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

.. autoapi-nested-parse::

   Tools for FDSN standards

   Created on Wed Sep 30 11:47:01 2020

   :author: Jared Peacock

   :license: MIT



Attributes
----------

.. autoapisummary::

   mt_metadata.timeseries.stationxml.fdsn_tools.release_dict
   mt_metadata.timeseries.stationxml.fdsn_tools.period_code_dict
   mt_metadata.timeseries.stationxml.fdsn_tools.measurement_code_dict
   mt_metadata.timeseries.stationxml.fdsn_tools.measurement_code_dict_reverse
   mt_metadata.timeseries.stationxml.fdsn_tools.orientation_code_dict
   mt_metadata.timeseries.stationxml.fdsn_tools.mt_components_dict
   mt_metadata.timeseries.stationxml.fdsn_tools.mt_orientation_dict
   mt_metadata.timeseries.stationxml.fdsn_tools.forced_orientation


Functions
---------

.. autoapisummary::

   mt_metadata.timeseries.stationxml.fdsn_tools.angle
   mt_metadata.timeseries.stationxml.fdsn_tools.create_location_code
   mt_metadata.timeseries.stationxml.fdsn_tools.get_period_code
   mt_metadata.timeseries.stationxml.fdsn_tools.get_measurement_code
   mt_metadata.timeseries.stationxml.fdsn_tools.get_orientation_code
   mt_metadata.timeseries.stationxml.fdsn_tools.make_channel_code
   mt_metadata.timeseries.stationxml.fdsn_tools.read_channel_code
   mt_metadata.timeseries.stationxml.fdsn_tools.create_mt_component


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

.. py:data:: release_dict

.. py:data:: period_code_dict

.. py:data:: measurement_code_dict

.. py:data:: measurement_code_dict_reverse

.. py:function:: angle(value)

.. py:data:: orientation_code_dict

.. py:data:: mt_components_dict

.. py:data:: mt_orientation_dict

.. py:data:: forced_orientation

.. py:function:: create_location_code(channel_obj)

   Get the location code given the components and channel number

   :param channel_obj: Channel object
   :type channel_obj: :class:`~mth5.metadata.Channel`
   :return: 2 character location code
   :rtype: string



.. py:function:: get_period_code(sample_rate)

   Get the SEED sampling rate code given a sample rate

   :param sample_rate: sample rate in samples per second
   :type sample_rate: float
   :return: single character SEED sampling code
   :rtype: string



.. py:function:: get_measurement_code(measurement)

   get SEED sensor code given the measurement type

   :param measurement: measurement type, e.g.
       * temperature
       * electric
       * magnetic
   :type measurement: string
   :return: single character SEED sensor code, if the measurement type has
            not been defined yet Y is returned.
   :rtype: string



.. py:function:: get_orientation_code(azimuth=None, direction=None, orientation='horizontal')

   Get orientation code given angle and orientation.  This is a general
   code and the true azimuth is stored in channel

   :param azimuth: angel assuming 0 is north, 90 is east, 0 is vertical down
   :type azimuth: float
   :param direction: character nominated direction [ x | y | z ]
   :return: single character SEED orientation code
   :rtype: string



.. py:function:: make_channel_code(sample_rate, measurement_type, azimuth, orientation='horizontal')

   Make channel code from given parameters

   :param sample_rate: sample rate in samples per second
   :type sample_rate: float
   :param measurement_type: type of measurement, e.g. 'electric'
   :type measurement_type: string
   :param orientation: orientation azimuth (degrees)
   :type orientation: float
   :return: three letter channel code
   :rtype: string



.. py:function:: read_channel_code(channel_code)

   read FDSN channel code

   :param channel_code: Three character string {Period}{Component}{Orientation}
   :type channel_code: string
   :return: DESCRIPTION
   :rtype: TYPE



.. py:function:: create_mt_component(channel_code)

   :param channel_code: Three character string {Period}{Component}{Orientation}
   :type channel_code: string
   :return: DESCRIPTION
   :rtype: TYPE

   Create a component for an MT channel given the measurement and orientation

   >>> create_mt_component("LQN")
   ex