ExtraHeaders-FDSN-v1.0.schema

Extra headers in miniSEED 3 data format

type

object

Schema

http://json-schema.org/draft-07/schema#

id

http://www.fdsn.org/schemas/ExtraHeaders-FDSN-v1.0.schema.json

definitions

Equipment

type

object

Additional properties allowed

No

Properties: Model, Serial

Model

Model of equipment

type

string

Serial

Serial number of equipment

type

string

Properties: FDSN

FDSN

Reserved extra headers defined by the FDSN

type

object

Additional properties allowed

No

Properties: Calibration, Clock, DataQuality, Event, Flags, Logger, ProvenanceURI, Recenter, Sensor, Sequence, Time

Calibration

Headers related to calibrations

type

object

Additional properties allowed

No

Properties: Sequence

Sequence

List of calibration sequences

type

array

Every element of Sequence is:

List of calibrations

type

object

Additional properties allowed

No

Properties: Amplitude, AmplitudeRange, BeginTime, Continued, Coupling, Duration, EndTime, InputChannel, InputUnits, Noise, ReferenceAmplitude, Rolloff, SinePeriod, StepAlternateSign, StepBetween, StepFirstPulsePositive, Steps, Trigger, Type

Amplitude

Amplitude of calibration signal. For pseudo-random calibrations, this should be the peak-to-peak amplitude of the steps. [same as SEED 2.4 Blockettes 300,310, field 8 and Blockettes 320,390, field 7]

type

number

AmplitudeRange

Amplitude range of calibration, use values of PEAKTOPEAK, ZEROTOPEAK, RMS OR RANDOM. [same as SEED 2.4 Blockette 310, field 5, bits 4,5,6 and Blockette 320, field 5, bit 4]

type

string

BeginTime

Calibration begin time. [similar to SEED 2.4 Blockettes 300,310,320,390, field 3]

type

string

format

date-time

Continued

Calibration is continued from previous records. [same as SEED 2.4 Blockettes 300,310,320,390, field 5, bit 3]

type

boolean

Coupling

Coupling of the calibration signal, such as RESISTIVE or CAPACITIVE. [same as SEED 2.4 Blockettes 300,310, field 12 and Blockette 320, field 11]

type

string

Duration

Duration of calibration in seconds. For step calibrations this is the duration of the step. [same as SEED 2.4 Blockettes 300,310,320,390, field 6]

type

number

EndTime

Calibration end time. [same as SEED 2.4 Blockette 395, field 3]

type

string

format

date-time

InputChannel

Channel containing the calibration input. [same as SEED 2.4 Blockettes 300,310, field 9 and Blockettes 320,390, field 8]

type

string

InputUnits

Units of calibration input, usually volts or amps. [same as SEED 2.4 Blockette 52, field 9]

type

string

Noise

Noise characteristics for pseudo-random calibrations, such as WHITE or RED. [same as SEED 2.4 Blockette 320, field 13]

type

string

ReferenceAmplitude

Reference amplitude. This is a user-defined value that indicates either the voltage or amperage of the calibration signal when the calibrator is set to 0dB. [same as SEED 2.4 Blockettes 300,310, field 11 and Blockette 320, field 10]

type

number

Rolloff

Rolloff characteristics for any filters used on the calibrator, such as 3dB@10Hz. [same as SEED 2.4 Blockettes 300,310, field 13 and Blockette 320, field 12]

type

string

SinePeriod

Period of sine calibrations in seconds. [same as SEED 2.4 Blockette 310, field 7]

type

number

StepAlternateSign

Step calibration alternate sign. [same as SEED 2.4 Blockettes 300, field 5, bit 1]

type

boolean

StepBetween

Interval between times a step calibration is on in seconds. [same as SEED 2.4 Blockette 300, field 7]

type

number

StepFirstPulsePositive

Step calibration, first pulse is positive. [same as SEED 2.4 Blockette 300, field 5, bit 0]

type

boolean

Steps

Number of step calibrations in sequence. [same as SEED 2.4 Blockette 300, field 4]

type

number

Trigger

Calibration trigger, use AUTOMATIC or MANUAL. [same as SEED 2.4 Blockettes 300,310,320,390, field 5, bit 2]

type

string

Type

Type of calibration: STEP, SINE, PSEUDORANDOM, GENERIC.

type

string

Clock

Description of clock system

Reference

Equipment#/

DataQuality

Data quality indicator, use D, R, Q or M. [same as SEED 2.4 FSDH, field 2]

type

string

Event

Headers related to event detection and progression

type

object

Additional properties allowed

No

Properties: Begin, Detection, End, InProgress

Begin

An event starts in this record. [same as SEED 2.4 FSDH, field 12, bit 2]

type

boolean

Detection

List of event detections

type

array

Every element of Detection is:

type

object

Additional properties allowed

No

Properties: BackgroundEstimate, Detector, MEDLookback, MEDPickAlgorithm, MEDSNR, OnsetTime, SignalAmplitude, SignalPeriod, Type, Units, Wave

BackgroundEstimate

Event background estimate in counts. [same as SEED 2.4 Blockettews 200 and 201, field 5]

type

number

Detector

Name of the event detector. [same as SEED 2.4 Blockette 200, field 9 and Blockette 201, field 12]

type

string

MEDLookback

Murdock event detction lookback value: 0, 1 or 2. [same as SEED 2.4 Blockette 201, field 10]

type

integer

MEDPickAlgorithm

Murdock event detection pick algorithm: 0 or 1. [same as SEED 2.4 Blockette 201, field 11]

type

integer

MEDSNR

Murdock event detection signal-to-noise ratios. [same as SEED 2.4 Blockette 201, field 9]

type

array

Every element of MEDSNR is:

type

number

OnsetTime

Event signal onset time. [same as SEED 2.4 Blockettews 200 and 201, field 8]

type

string

format

date-time

SignalAmplitude

Event amplitude of signal in counts. [same as SEED 2.4 Blockettews 200 and 201, field 3]

type

number

SignalPeriod

Event period of signal in seconds. [same as SEED 2.4 Blockettews 200 and 201, field 4]

type

number

Type

Type of event detection, e.g. MURDOCK

type

string

Units

Units of amplitude band background estimate, use COUNTS for unprocessed signal. [similar to SEED 2.4 Blockettews 200, field 6, bit 1]

type

string

Wave

Event detection wave, use values of DILATATION or COMPRESSION if determined. [same as SEED 2.4 Blockettews 200 and 201, field 6, bit 0]

type

string

End

An in-progress event ends in this record, i.e. the detection algorithm de-triggers. [same as SEED 2.4 FSDH, field 12, bit 3]

type

boolean

InProgress

An event is in progress. [same as SEED 2.4 FSDH, field 12, bit 6]

type

boolean

Flags

type

object

Additional properties allowed

No

Properties: AmplifierSaturation, DigitizerClipping, EndOfTimeSeries, FilterCharging, Glitches, LongRecordRead, MassPositionOffscale, MissingData, ShortRecordRead, Spikes, StartOfTimeSeries, StationVolumeParityError, TelemetrySyncError

AmplifierSaturation

Amplifier saturation detected. [same as SEED 2.4 FSDH, field 14, bit 0]

type

boolean

DigitizerClipping

Digitizer clipping detected. [same as SEED 2.4 FSDH, field 14, bit 1]

type

boolean

EndOfTimeSeries

DEPRECATED End of time series. [same as SEED 2.4 FDSH, field 13, bit 4]

type

boolean

FilterCharging

A digital filter may be charging. [same as SEED 2.4 FDSH, field 14, bit 6]

type

boolean

Glitches

Glitches detected. [same as SEED 2.4 FSDH, field 14, bit 3]

type

boolean

LongRecordRead

DEPRECATED Long record read (possibly no problem). [same as SEED 2.4 FDSH, field 13, bit 1]

type

boolean

MassPositionOffscale

Sensor mass position is offscale as defined by the vendor or operator.

type

boolean

MissingData

DEPRECATED Missing data. [same as SEED 2.4 FDSH, field 14, bit 4]

type

boolean

ShortRecordRead

DEPRECATED Short record read (record padded). [same as SEED 2.4 FDSH, field 13, bit 2]

type

boolean

Spikes

Spikes detected. [same as SEED 2.4 FSDH, field 14, bit 2]

type

boolean

StartOfTimeSeries

DEPRECATED Start of time series. [same as SEED 2.4 FDSH, field 13, bit 3]

type

boolean

StationVolumeParityError

DEPRECATED Station volume parity error possibly present. [same as SEED 2.4 FDSH, field 13, bit 0]

type

boolean

TelemetrySyncError

DEPRECATED Telemetry synchronization error. [same as SEED 2.4 FDSH, field 14, bit 5]

type

boolean

Logger

Description of data logger

Reference

Equipment#/

ProvenanceURI

An identifier for a provenance description

type

string

Recenter

Headers related to sensor recentering (mass, gimble, etc.)

type

object

Additional properties allowed

No

Properties: Sequence

Sequence

List of recentering sequences

type

array

Every element of Sequence is:

List of recenterings

type

object

Additional properties allowed

No

Properties: BeginTime, EndTime, Trigger, Type

BeginTime

Recenter begin time.

type

string

format

date-time

EndTime

Estimate of recenter end time.

type

string

format

date-time

Trigger

Calibration trigger, use AUTOMATIC or MANUAL.

type

string

Type

Type of recenter: Mass, Gimbal, etc. If omitted a mass recenter may be assumed.

type

string

Sensor

Description of sensor

Reference

Equipment#/

Sequence

Data record sequence number. [same as SEED 2.4 FSDH, field 1]

type

integer

Time

Headers related to data timing and recording system clock

type

object

Additional properties allowed

No

Properties: Correction, Exception, LeapSecond, MaxEstimatedError, Quality

Correction

Time correction applied to record start time in seconds. [same as SEED 2.4 FSDH, field 16]

type

number

Exception

List of timing exceptions

type

array

Every element of Exception is:

type

object

Additional properties allowed

No

Properties: ClockStatus, Count, ReceptionQuality, Time, Type, VCOCorrection

ClockStatus

Description of clock status, clock specific parameters such as the station for an Omega clock or satellite signal to noise ratios for GPS clocks. [same as SEED 2.4 Blockette 500, field 10]

type

string

Count

Exception count, with meaning based on type of exception, such as 15 missing time marks. [same as SEED 2.4 Blockette 500, field 7]

type

integer

ReceptionQuality

Reception quality as a percent of maximum clock accuracy based only on information from the clock. [same as SEED 2.4 Blockette 500, field 6]

type

integer

Time

Time of timing exeption. [same as SEED 2.4 Blockette 500, field 4]

type

string

format

date-time

Type

Description of clock exception, such as MISSING TIMEMARK. [same as SEED 2.4 Blockette 500, field 8]

type

string

VCOCorrection

VCO correction, a percentage from 0 to 100% of VCO control value, where 0 is the slowest and 100 is the fastest. [same as SEED 204 Blockette 500, field 3]

type

number

LeapSecond

If present, one or more leap seconds occuring during this record. The value specifies the number of leap seconds and direction. For example, use 1 to specify a single positive leap second and -1 to specify a single negative leap second. [incorporates SEED 2.4 FSDH, field 12, bits 4 and 5]

type

integer

MaxEstimatedError

Maximum estimated timing error in seconds.

type

number

Quality

Timing quality. A vendor specific value from 0 to 100% of maximum accuracy. [same as SEED 2.4 Blockette 1001, field 3]

type

number