Stages

Description

Stages are discrete units in the block diagram of an electronic circuit which perform a specific function and is usually physically circumscribed to a printed board. An instrument component in obsinfo is usually composed of several chained stages which connect the output of one stage to the input of the next one. This class implements the change of individual stages.

It is important that contiguous stages are consistent in two ways:

  1. Output units of a stage must be equal to input units of the next stage

  2. Output sample rate of a stage must match the input sample rate of the next stage

Python class:

Stages

YAML / JSON label:

stages

Corresponding StationXML structure

Response

Object Hierarchy

Superclass

None

Subclasses

None

Relationships

Attributes

Name

Type

Required

Default

Equivalent StationXML

Remarks

Stage

Array of Stage

N

None

StageFDSN

Calculated Attributes

These attributes do not exist in the YAML/JSON file. They are or may be calculated programmatically to feed corresponding values in the StationXML file or for other purposes.

Name

Type

Default

Equivalent StationXML

Remarks

number

number

None

Stage. Number

Calculated depending on position

sensitivity

number

None

InstrumentSensitivity

Calculated with obspy.obspy_Sensitivity using gain.frequency of first stage as reference frequency and then recalculated with frequency out of sensitivity calculation.

total_sample_rate

number

None

None

Calculated as sum of stage sample rates in order to validate against declared sample_rate.

JSON schema

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

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

Example

Response stages part of a datalogger information file https://www.gitlab.com/resif/obsinfo/-/tree/master/obsinfo/_examples/Information_Files/dataloggers/LC2000.datalogger.yaml

stages:
               - $ref: "responses/CS5321_FIR1.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR3.stage.yaml#stage"

Class Navigation

InstrumentComponent <==> Stage