SensorComponent

class mss_dataserver.geometry.inventory.SensorComponent(name, description=None, input_unit=None, output_unit=None, deliver_unit=None, author_uri=None, agency_uri=None, creation_time=None, parent_sensor=None)[source]

Bases: object

A component of a seismic sensor.

A seismic sensor may have multiple components. Usually, one component is related to one spatial direction. A 3-component geophone has 3 sensor components oriented along an orthogonal coordinate system.

Parameters

  • name (str) – The name of the sensor component.

  • description (str) – The description of the sensor component.

  • input_unit (str) – The physical unit of the sensor input domain (e.g. m).

  • output_unit (str) – The physical unit of the sensor output domain (e.g. m/s).

  • deliver_unit (str) – The unit of the measureable signal which is proportional to the output unit (e.g. V).

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

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

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

  • parent_sensor (Sensor) – The sensor containing the component.

Variables

parameters (:obj:list of SensorComponentParameter) – The sensor component parameters.

Properties

assigned_streams

:obj:list of RecorderStream: The recorder streams to which the component is assigned to.

model

str: The parent sensor model.

parent_inventory

Inventory: The inventory holding the sensor component.

producer

str: The parent sensor producer.

serial

str: The parent sensor serial.

Methods

__init__(name[, description, input_unit, …])

Initialize the instance.

add_parameter(parameter_to_add)

Add a sensor component paramter instance to the sensor component.

change_parameter_end_time(position, end_time)

Change a parameter end time.

change_parameter_start_time(position, start_time)

Change a parameter start time.

get_parameter([start_time, end_time])

Get sensor component parameters.

merge(merge_component)

Merge two components.

remove_parameter(parameter_to_remove)

Remove a parameter from the component.

Inheritence diagram

Inheritance diagram of mss_dataserver.geometry.inventory.SensorComponent