mt_metadata.timeseries.stationxml.fdsn_tools

Tools for FDSN standards

Created on Wed Sep 30 11:47:01 2020

author:

Jared Peacock

license:

MIT

Attributes

release_dict

period_code_dict

measurement_code_dict

measurement_code_dict_reverse

orientation_code_dict

mt_components_dict

mt_orientation_dict

forced_orientation

Functions

angle(value)

create_location_code(channel_obj)

Get the location code given the components and channel number

get_period_code(sample_rate)

Get the SEED sampling rate code given a sample rate

get_measurement_code(measurement)

get SEED sensor code given the measurement type

get_orientation_code([azimuth, direction, orientation])

Get orientation code given angle and orientation. This is a general

make_channel_code(sample_rate, measurement_type, azimuth)

Make channel code from given parameters

read_channel_code(channel_code)

read FDSN channel code

create_mt_component(channel_code)

Module Contents

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.angle(value)
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
mt_metadata.timeseries.stationxml.fdsn_tools.create_location_code(channel_obj)

Get the location code given the components and channel number

Parameters:

channel_obj (Channel) – Channel object

Returns:

2 character location code

Return type:

string

mt_metadata.timeseries.stationxml.fdsn_tools.get_period_code(sample_rate)

Get the SEED sampling rate code given a sample rate

Parameters:

sample_rate (float) – sample rate in samples per second

Returns:

single character SEED sampling code

Return type:

string

mt_metadata.timeseries.stationxml.fdsn_tools.get_measurement_code(measurement)

get SEED sensor code given the measurement type

Parameters:

measurement (string) – measurement type, e.g. * temperature * electric * magnetic

Returns:

single character SEED sensor code, if the measurement type has not been defined yet Y is returned.

Return type:

string

mt_metadata.timeseries.stationxml.fdsn_tools.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

Parameters:

  • azimuth (float) – angel assuming 0 is north, 90 is east, 0 is vertical down

  • direction – character nominated direction [ x | y | z ]

Returns:

single character SEED orientation code

Return type:

string

mt_metadata.timeseries.stationxml.fdsn_tools.make_channel_code(sample_rate, measurement_type, azimuth, orientation='horizontal')

Make channel code from given parameters

Parameters:

  • sample_rate (float) – sample rate in samples per second

  • measurement_type (string) – type of measurement, e.g. ‘electric’

  • orientation (float) – orientation azimuth (degrees)

Returns:

three letter channel code

Return type:

string

mt_metadata.timeseries.stationxml.fdsn_tools.read_channel_code(channel_code)

read FDSN channel code

Parameters:

channel_code (string) – Three character string {Period}{Component}{Orientation}

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.timeseries.stationxml.fdsn_tools.create_mt_component(channel_code)
Parameters:

channel_code (string) – Three character string {Period}{Component}{Orientation}

Returns:

DESCRIPTION

Return type:

TYPE

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

>>> create_mt_component("LQN")
ex