obspy.core.inventory.response.InstrumentSensitivity

class InstrumentSensitivity(value, frequency, input_units, output_units, input_units_description=None, output_units_description=None, frequency_range_start=None, frequency_range_end=None, frequency_range_db_variation=None)[source]

Bases: obspy.core.util.base.ComparingObject

From the StationXML Definition:

The total sensitivity for a channel, representing the complete acquisition system expressed as a scalar. Equivalent to SEED stage 0 gain with (blockette 58) with the ability to specify a frequency range.

Sensitivity and frequency ranges. The FrequencyRangeGroup is an optional construct that defines a pass band in Hertz (FrequencyStart and FrequencyEnd) in which the SensitivityValue is valid within the number of decibels specified in FrequencyDBVariation.

Private Methods

Warning

Private methods are mainly for internal/developer use and their API might change without notice.

InstrumentSensitivity._repr_pretty_(p, cycle)[source]

Special Methods

InstrumentSensitivity.__delattr__(name, /)

Implement delattr(self, name).

InstrumentSensitivity.__dir__()

Default dir() implementation.

InstrumentSensitivity.__eq__(other)
InstrumentSensitivity.__format__(format_spec, /)

Default object formatter.

InstrumentSensitivity.__ge__(value, /)

Return self>=value.

InstrumentSensitivity.__getattribute__(name, /)

Return getattr(self, name).

InstrumentSensitivity.__gt__(value, /)

Return self>value.

InstrumentSensitivity.__init__(value, frequency, input_units, output_units, input_units_description=None, output_units_description=None, frequency_range_start=None, frequency_range_end=None, frequency_range_db_variation=None)[source]
Parameters

  • value (float) – Complex type for sensitivity and frequency ranges. This complex type can be used to represent both overall sensitivities and individual stage gains. The FrequencyRangeGroup is an optional construct that defines a pass band in Hertz ( FrequencyStart and FrequencyEnd) in which the SensitivityValue is valid within the number of decibels specified in FrequencyDBVariation.

  • frequency (float) – Complex type for sensitivity and frequency ranges. This complex type can be used to represent both overall sensitivities and individual stage gains. The FrequencyRangeGroup is an optional construct that defines a pass band in Hertz ( FrequencyStart and FrequencyEnd) in which the SensitivityValue is valid within the number of decibels specified in FrequencyDBVariation.

  • input_units – string

  • input_units – The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units. Name of units, e.g. “M/S”, “V”, “PA”.

  • input_units_description – string, optional

  • input_units_description – The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units. Description of units, e.g. “Velocity in meters per second”, “Volts”, “Pascals”.

  • output_units – string

  • output_units – The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response. Name of units, e.g. “M/S”, “V”, “PA”.

  • output_units_description (str, optional) – The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response. Description of units, e.g. “Velocity in meters per second”, “Volts”, “Pascals”.

  • frequency_range_start (float, optional) – Start of the frequency range for which the SensitivityValue is valid within the dB variation specified.

  • frequency_range_end (float, optional) – End of the frequency range for which the SensitivityValue is valid within the dB variation specified.

  • frequency_range_db_variation (float, optional) – Variation in decibels within the specified range.

InstrumentSensitivity.__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

InstrumentSensitivity.__le__(value, /)

Return self<=value.

InstrumentSensitivity.__lt__(value, /)

Return self<value.

InstrumentSensitivity.__ne__(other)
InstrumentSensitivity.__new__(**kwargs)
InstrumentSensitivity.__reduce__()

Helper for pickle.

InstrumentSensitivity.__reduce_ex__(protocol, /)

Helper for pickle.

InstrumentSensitivity.__repr__()

Return repr(self).

InstrumentSensitivity.__setattr__(name, value, /)

Implement setattr(self, name, value).

InstrumentSensitivity.__sizeof__()

Size of object in memory, in bytes.

InstrumentSensitivity.__str__()[source]
InstrumentSensitivity.__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).