Datalogger

Description

A datalogger is the part of an OBS instrument which records the signal after processing. It is an InstrumentComponent with response stages and attributes such as the global delay correction and the overall sample rate of the instrument.

Python class:

Datalogger

YAML / JSON label:

datalogger

Corresponding StationXML structure

Datalogger

Object Hierarchy

Superclass

InstrumentComponent

Subclasses

None

Relationships

Is element of Equipment
Contains Stages

Attributes

Name	Type	Required	Default	Equivalent StationXML	Remarks
sample_rate	number	Y	None	None
correction	number	N	None	None	Used by obsinfo to calculate StationXML `correction` for each stage. correction will be set to 0 for each stage except the last, which is the value of correction.

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

JSON schema

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

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

Example

Datalogger information file https://www.gitlab.com/resif/obsinfo/-/tree/master/obsinfo/_examples/Information_Files/dataloggers/LC2000.datalogger.yaml :

--
format_version: "0.110"
revision:
   date: "2019-12-20"
   authors:
       - $ref: 'authors/Wayne_Crawford.author.yaml#author'
notes:
   - "Delay correction is hard-coded to 29 samples in LCHEAPO software"

datalogger:
   equipment:
       model: "CS5321/22"
       type: "delta-sigma A/D converter + digital filter"
       description: "CS5321/22 delta-sigma A/D converter + FIR digital filter"
       manufacturer: "Cirrus Logic"
       vendor: "various"
   configuration_default: "125 sps"

   configuration_definitions:
       "62.5sps":
           config_description: "62.5 sps"
           sample_rate: 62.5
           correction: 0.464
           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_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"
       "125sps":
           config_description: "125 sps"
           sample_rate: 125
           correction: 0.232
           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_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR3.stage.yaml#stage"
       "250sps":
           config_description: "250 sps"
           sample_rate: 250
           correction: 0.116
           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_FIR2.stage.yaml#stage"
               - $ref: "responses/CS5322_FIR3.stage.yaml#stage"
       "500sps":
           config_description: "500 sps"
           sample_rate: 500
           correction: 0.058
           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"
       "1000sps":
           config_description: "1000 sps"
           sample_rate: 1000
           correction: 0.029
           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_FIR3.stage.yaml#stage"