obspy.core.inventory.response.ResponseStage

class ResponseStage(stage_sequence_number, stage_gain, stage_gain_frequency, input_units, output_units, resource_id=None, resource_id2=None, name=None, input_units_description=None, output_units_description=None, description=None, decimation_input_sample_rate=None, decimation_factor=None, decimation_offset=None, decimation_delay=None, decimation_correction=None)[source]

Bases: ComparingObject

From the StationXML Definition:

This complex type represents channel response and covers SEED blockettes 53 to 56.

Private Methods

Warning

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

ResponseStage._repr_pretty_(p, cycle)[source]

Special Methods

ResponseStage.__delattr__(name, /)

Implement delattr(self, name).

ResponseStage.__dir__()

Default dir() implementation.

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

Default object formatter.

ResponseStage.__ge__(value, /)

Return self>=value.

ResponseStage.__getattribute__(name, /)

Return getattr(self, name).

ResponseStage.__gt__(value, /)

Return self>value.

ResponseStage.__init__(stage_sequence_number, stage_gain, stage_gain_frequency, input_units, output_units, resource_id=None, resource_id2=None, name=None, input_units_description=None, output_units_description=None, description=None, decimation_input_sample_rate=None, decimation_factor=None, decimation_offset=None, decimation_delay=None, decimation_correction=None)[source]
Parameters:

  • stage_sequence_number (int) – Stage sequence number, greater or equal to zero. This is used in all the response SEED blockettes.

  • stage_gain (float) – Value of stage gain.

  • stage_gain_frequency (float) – Frequency of stage gain.

  • input_units (str) – 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”.

  • output_units (str) – 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”.

  • resource_id (str) – This field contains a string that should serve as a unique resource identifier. This identifier can be interpreted differently depending on the data center/software that generated the document. Also, we recommend to use something like GENERATOR:Meaningful ID. As a common behavior equipment with the same ID should contains the same information/be derived from the same base instruments.

  • resource_id2 (str) – This field contains a string that should serve as a unique resource identifier. Resource identifier of the subgroup of the response stage that varies across different response stage types (e.g. the poles and zeros part or the FIR part).

  • name (str) – A name given to the filter stage.

  • input_units_description (str, optional) – 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_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”.

  • description (str, optional) – A short description of of the filter.

  • decimation_input_sample_rate (float, optional) – The sampling rate before the decimation in samples per second.

  • decimation_factor (int, optional) – The applied decimation factor.

  • decimation_offset (int, optional) – The sample chosen for use. 0 denotes the first sample, 1 the second, and so forth.

  • decimation_delay (float, optional) – The estimated pure delay from the decimation.

  • decimation_correction (float, optional) – The time shift applied to correct for the delay at this stage.

Note

The stage gain (or stage sensitivity) is the gain at the stage of the encapsulating response element and corresponds to SEED blockette 58. In the SEED convention, stage 0 gain represents the overall sensitivity of the channel. In this schema, stage 0 gains are allowed but are considered deprecated. Overall sensitivity should be specified in the InstrumentSensitivity element.

ResponseStage.__init_subclass__()

This method is called when a class is subclassed.

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

ResponseStage.__le__(value, /)

Return self<=value.

ResponseStage.__lt__(value, /)

Return self<value.

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

Helper for pickle.

ResponseStage.__reduce_ex__(protocol, /)

Helper for pickle.

ResponseStage.__repr__()

Return repr(self).

ResponseStage.__setattr__(name, value, /)

Implement setattr(self, name, value).

ResponseStage.__sizeof__()

Size of object in memory, in bytes.

ResponseStage.__str__()[source]
ResponseStage.__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).