ms3eh

Bag Extra Header

Title: Bag Extra Header

   
Type object
Required No
Additional properties [Any type: allowed]

Description: Common metadata json about a seismogram.

Property Pattern Type Deprecated Definition Title/Description
- y No object No In #/$defs/Timeseries timeseries units and processing state
- ch No object No In #/$defs/Channel recording station/channel
- ev No object No In #/$defs/Event source earthquake
- path No object No In #/$defs/Path path between source and receiver
- mark No array No - markers, picks or predicted arrival times

1. Property Bag Extra Header > y

   
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/$defs/Timeseries

Description: timeseries units and processing state

Property Pattern Type Deprecated Definition Title/Description
+ si No string No - si units of the timeseries amplitude, ex: count, m/s, m/s2
- proc No enum (of string) No - basic processing type. Raw is unprocessed, gain has scalar gain/units, corrected transfer of frequency response, processed further userlevel processing
- req No object No - source of timeseries data

1.1. Property Bag Extra Header > y > si

   
Type string
Required Yes

Description: si units of the timeseries amplitude, ex: count, m/s, m/s2

1.2. Property Bag Extra Header > y > proc

   
Type enum (of string)
Required No

Description: basic processing type. Raw is unprocessed, gain has scalar gain/units, corrected transfer of frequency response, processed further userlevel processing

Must be one of:

1.3. Property Bag Extra Header > y > req

   
Type object
Required No
Additional properties [Any type: allowed]

Description: source of timeseries data

Property Pattern Type Deprecated Definition Title/Description
- dc No string No - data center, should be name in FDSN data center registry
- sttm No string No Same as tm start time of request as ISO8601. May be different from start of timeseries due to missing data
- endtm No string No Same as tm end time of request as ISO8601. May be different from end of timeseries due to missing data
- reqtm No string No Same as tm time request was made as ISO8601.

1.3.1. Property Bag Extra Header > y > req > dc

   
Type string
Required No

Description: data center, should be name in FDSN data center registry

1.3.2. Property Bag Extra Header > y > req > sttm

   
Type string
Required No
Same definition as tm

Description: start time of request as ISO8601. May be different from start of timeseries due to missing data

1.3.3. Property Bag Extra Header > y > req > endtm

   
Type string
Required No
Same definition as tm

Description: end time of request as ISO8601. May be different from end of timeseries due to missing data

1.3.4. Property Bag Extra Header > y > req > reqtm

   
Type string
Required No
Same definition as tm

Description: time request was made as ISO8601.

2. Property Bag Extra Header > ch

   
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/$defs/Channel

Description: recording station/channel

Property Pattern Type Deprecated Definition Title/Description
+ la No number No - latitude in degrees
+ lo No number No - longitude in degrees
- el No number No - elevation in meters
- dp No number No - depth below surface in meters
- az No number No - channel azimuth from north in degrees
- dip No number No - channel dip from horizontal in degrees, up is -90

2.1. Property Bag Extra Header > ch > la

   
Type number
Required Yes

Description: latitude in degrees

2.2. Property Bag Extra Header > ch > lo

   
Type number
Required Yes

Description: longitude in degrees

2.3. Property Bag Extra Header > ch > el

   
Type number
Required No

Description: elevation in meters

2.4. Property Bag Extra Header > ch > dp

   
Type number
Required No

Description: depth below surface in meters

2.5. Property Bag Extra Header > ch > az

   
Type number
Required No

Description: channel azimuth from north in degrees

2.6. Property Bag Extra Header > ch > dip

   
Type number
Required No

Description: channel dip from horizontal in degrees, up is -90

3. Property Bag Extra Header > ev

   
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/$defs/Event

Description: source earthquake

Property Pattern Type Deprecated Definition Title/Description
- id No string No - public identifier for earthquake
- or No object No Same as or origin, location and time
- mag No object No Same as mag magnitude
- mt No object No Same as mt moment tensor

3.1. Property Bag Extra Header > ev > id

   
Type string
Required No

Description: public identifier for earthquake

3.2. Property Bag Extra Header > ev > or

   
Type object
Required No
Additional properties [Any type: allowed]
Same definition as or

Description: origin, location and time

3.3. Property Bag Extra Header > ev > mag

   
Type object
Required No
Additional properties [Any type: allowed]
Same definition as mag

Description: magnitude

3.4. Property Bag Extra Header > ev > mt

   
Type object
Required No
Additional properties [Any type: allowed]
Same definition as mt

Description: moment tensor

4. Property Bag Extra Header > path

   
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/$defs/Path

Description: path between source and receiver

Property Pattern Type Deprecated Definition Title/Description
- gcarc No number No - great circle arc distance in degrees, for uses when only distance is needed
- az No number No - great circle azimuth degrees from event to station, for uses when only distance is needed
- baz No number No - great circle back azimuth in degrees back from station to event, for uses when only distance is needed

4.1. Property Bag Extra Header > path > gcarc

   
Type number
Required No

Description: great circle arc distance in degrees, for uses when only distance is needed

4.2. Property Bag Extra Header > path > az

   
Type number
Required No

Description: great circle azimuth degrees from event to station, for uses when only distance is needed

4.3. Property Bag Extra Header > path > baz

   
Type number
Required No

Description: great circle back azimuth in degrees back from station to event, for uses when only distance is needed

5. Property Bag Extra Header > mark

   
Type array
Required No

Description: markers, picks or predicted arrival times

  Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
Marker -

5.1. Bag Extra Header > mark > Marker

   
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/$defs/Marker
Property Pattern Type Deprecated Definition Title/Description
+ tm No string No Same as tm marker time as ISO8601
+ n No string No - name of the marker, like P
- mtype No string No - type of marker, usual ‘pk’ for measurement/pick on data or ‘md’ for predicted from model
- amp No number No - -
- desc No string No - -

5.1.1. Property Bag Extra Header > mark > mark items > tm

   
Type string
Required Yes
Same definition as tm

Description: marker time as ISO8601

5.1.2. Property Bag Extra Header > mark > mark items > n

   
Type string
Required Yes

Description: name of the marker, like P

5.1.3. Property Bag Extra Header > mark > mark items > mtype

   
Type string
Required No

Description: type of marker, usual ‘pk’ for measurement/pick on data or ‘md’ for predicted from model

5.1.4. Property Bag Extra Header > mark > mark items > amp

   
Type number
Required No

5.1.5. Property Bag Extra Header > mark > mark items > desc

   
Type string
Required No

Generated using json-schema-for-humans on 2024-10-10 at 10:53:51 -0400