SensorComponentParameter

class mss_dataserver.geometry.inventory.SensorComponentParameter(sensitivity, start_time, end_time, tf_type=None, tf_units=None, tf_normalization_factor=None, tf_normalization_frequency=None, tf_poles=None, tf_zeros=None, parent_component=None, author_uri=None, agency_uri=None, creation_time=None)[source]

Bases: object

The parameters of a sensor component.

Parameters

  • sensitivity (float) – The sensor sensitivity.

  • start_time (obspy.UTCDateTime) – The start time from which the parameters where active.

  • end_time (obspy.UTCDateTime) – The end time to which the parameters where active.

  • tf_type (str) – DEPRECATED. The type of the transfer function.

  • tf_units (str) – DEPRECATED. The units of the transfer function.

  • tf_normalization_factor (float) – The normalization factor of the transfer function.

  • tf_normalization_frequency (float) – The frequency where the normalization factor was measured.

  • tf_poles (list of complex) – The pole locations of the transfer function.

  • tf_zeros (list of complex) – The zero locations of the transfer function.

  • parent_component (SensorComponent) – The sensor component to which the parameters are related to.

  • author_uri (string) – The author_uri of the instance.

  • agency_uri (String) – The agency_uri of the instance.

  • creation_time (str or obspy.UTCDateTime) – The creation time of the instance. A string that can be parsed by obspy.UTCDateTime or a obspy.UTCDateTime instance

Properties

end_time_string

str: The end time of the active parameter period.

parent_inventory

Inventory: The inventory containing the parameter.

poles_string

str: A string representation of the transfer function poles.

start_time_string

str: The start time of the active parameter period.

zeros_string

str: A string representation of the transfer functin zeros.

Methods

__init__(sensitivity, start_time, end_time)

Initialize self.

set_transfer_function(tf_type, tf_units, …)

Set the transfer function parameters.

tf_add_complex_pole(pole)

Add a complex pole to the transfer function.

tf_add_complex_zero(zero)

Add a complex zero to the transfer function.

Inheritence diagram

Inheritance diagram of mss_dataserver.geometry.inventory.SensorComponentParameter