Sensor

Description

A sensor is an InstrumentComponent belonging to an Instrument. It models an OBS sensor and so is the generator of the signal being processed. Inheriting from InstrumentComponent, it has all its attributes plus the ones below.

Python class:

Sensor

YAML / JSON label:

sensor: Sensor usually has its own information file (best practice)

Corresponding StationXML structure

Channel.Sensor

Object Hierarchy

Superclass

InstrumentComponent

Subclasses

None

Relationships

Contains Stages
Is part of an Instrument

Attributes

Name	Type	Required	Default	Equivalent StationXML	Remarks
seed_codes	SeedCodes	Y	None	Channel. code	See explanation in class SeedCodes Only first two codes set here. Orientation set at channel level.

For the rest of attributes, see superclass :ref:`InstrumentComponent <InstrumentComponent>`

JSON schema

https://www.gitlab.com/resif/smm/obsinfo/-/tree/master/obsinfo/data/schemas/sensor_base.schema.json

Example

file: _templates/TEMPLATE.sensor_base.yaml

---
format_version: "1.0"
revision:
    authors:
        - {$ref: "persons/EXAMPLE.person.yaml"} # Reference to a file,
                                                 # or fields of a person element
    date: "2024-09-30" # yyyy-mm-dd
sensor_base:
    seed_codes:
        band: "broadband" # 'broadband', 'shortperiod', "A", "I", "O", "L", or "S"
                          # If "broadband" or "shortperiod", will chose the appropriate
                          # code according to the sampling rate
        instrument: "H"  # Seed "instrument" (or "source") code
    equipment:
        model: "CMG-3T"
        type: "Broadband seismometer"
        description: "Triaxial force-feedback seismometer"
        manufacturer: "Guralp, Ltd"
        # BEGIN OPTIONAL equipment elements
        vendor: "various"
        serial_number: "2014a2"
        installation_date: "2024-09-30"
        removal_date: "2025-08-31"
        resource_id: "IPGP:2004iepw44" # Unique ID of the filter, typically
                                       # "GENERATOR:Meaningful_ID"
        calibration_dates: 
           - "2004-09-22T07:00:00"
           - "2014-08-31T07:00:00"
        # END OPTIONAL equipment elements
    stages:
        -  base: {$ref: "sensor_bases/stage_bases/EXAMPLE_BBSeismometer.stage_base.yaml"}
           # BEGIN OPTIONAL stage elements
           configuration: "SN1-399, differential"
           # END OPTIONAL stage elements
    # BEGIN OPTIONAL sensor_base elements
    stage_modifications: {}
    notes: [""]
    configuration_default: "DEFAULT"
    configurations:
        "DEFAULT":
          configuration_description: "Default configuration"
        "High Gain":
          configuration description: "High gain configuration"
          stage_modifications:
              "1": {gain: {value: 100}}
        "Low Gain":
          configuration description: "Low gain configuration"
          stage_modifications:
              "1": {gain: {value: 1}}
    # END OPTIONAL sensor_base elements
# BEGIN OPTIONAL top-level elements
notes: 
   - ""
# END OPTIONAL top-level elements