Skip to content

Latest commit

 

History

History
1832 lines (1538 loc) · 139 KB

tf_electric.rst

File metadata and controls

1832 lines (1538 loc) · 139 KB

Electric

dipole_length

dipole_length Description Example

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

Length of the dipole as measured in a straight line from electrode to electrode. 55.25

contact_resistance.start

contact_resistance.start Description Example

Required: False

Units: ohms

Type: float

Style: number list

Default: None

Starting contact resistance; if more than one measurement input as a list of number [1 2 3 ...]. "[1.2, 1.4]"

contact_resistance.end

contact_resistance.end Description Example

Required: False

Units: ohms

Type: float

Style: number list

Default: None

Ending contact resistance; if more than one measurement input as a list of number [1 2 3 ...]. "[1.5, 1.8]"

ac.start

ac.start Description Example

Required: False

Units: volts

Type: float

Style: number

Default: None

Starting AC value; if more than one measurement input as a list of number [1 2 3 ...]. "[52.1, 55.8]"

ac.end

ac.end Description Example

Required: False

Units: volts

Type: float

Style: number

Default: None

Ending AC value; if more than one measurement input as a list of number [1 2 3 ...]. "[45.3, 49.5]"

dc.start

dc.start Description Example

Required: False

Units: volts

Type: float

Style: number

Default: None

Starting DC value; if more than one measurement input as a list of number [1 2 3 ...]. 1.1

dc.end

dc.end Description Example

Required: False

Units: volts

Type: float

Style: number

Default: None

Ending DC value; if more than one measurement input as a list of number [1 2 3 ...]. 1.5

channel_number

channel_number Description Example

Required: True

Units: None

Type: integer

Style: number

Default: 0

Channel number on the data logger. 1

channel_id

channel_id Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

channel id given by the user or data logger 1001.11

comments

comments Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

Any comments about the channel. ambient air temperature was chilly, ice on cables

component

component Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: None

Name of the component measured, can be uppercase and/or lowercase. For now electric channels should start with an 'e' and magnetic channels start with an 'h', followed by the component. If there are multiples of the same channel the name could include an integer. {type}{component}{number} --> Ex01. T

measurement_azimuth

measurement_azimuth Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

Horizontal azimuth of the channel in measurement coordinate system spcified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward. 0

measurement_tilt

measurement_tilt Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

Vertical tilt of the channel in measurement coordinate system specified in station.orientation.reference_frame. Default reference frame is a geographic right-handed coordinate system with north=0, east=90, vertical=+ downward. 0

sample_rate

sample_rate Description Example

Required: True

Units: samples per second

Type: float

Style: number

Default: 0.0

Digital sample rate 8

translated_azimuth

translated_azimuth Description Example

Required: False

Units: degrees

Type: float

Style: number

Default: None

Horizontal azimuth of the channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data in geomagnetic coordinates and then translated them to geographic coordinates you would set measurement_azimuth=0, translated_azimuth=-12.5 for a declination angle of N12.5E. 0

translated_tilt

translated_tilt Description Example

Required: False

Units: degrees

Type: float

Style: number

Default: None

Tilt of channel in translated coordinate system, this should only be used for derived product. For instance if you collected your data using a tripod you would set measurement_tilt=45, translated_tilt=0 for a vertical component. 0

type

type Description Example

Required: True

Units: None

Type: string

Style: free form

Default: none

Data type for the channel, should be a descriptive word that a user can understand. temperature

units

units Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: None

Units of the data, should be in SI units and represented as the full name of the unit all lowercase. If a complex unit use 'per' and '-'. celsius

data_quality.warnings

data_quality.warnings Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

any warnings about the data that should be noted periodic pipeline noise

data_quality.good_from_period

data_quality.good_from_period Description Example

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number 0.01

data_quality.good_to_period

data_quality.good_to_period Description Example

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number 1000

data_quality.flag

data_quality.flag Description Example

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality 0

data_quality.comments

data_quality.comments Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

any comments about the data quality 0

data_quality.rating.author

data_quality.rating.author Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

Author of who rated the data. gradstudent ace

data_quality.rating.method

data_quality.rating.method Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

The method used to rate the data. standard deviation

data_quality.rating.value

data_quality.rating.value Description Example

Required: True

Units: None

Type: integer

Style: number

Default: 0

A rating from 1-5 where 1 is bad and 5 is good and 0 if unrated. 4

filter.name

filter.name Description Example

Required: True

Units: None

Type: string

Style: name list

Default: []

Name of filter applied or to be applied. If more than one filter input as a comma separated list. "[counts2mv, lo wpass_magnetic] "

filter.applied

filter.applied Description Example

Required: True

Units: None

Type: boolean

Style: name list

Default: []

Boolean if filter has been applied or not. If more than one filter input as a comma separated list. Needs to be the same length as name or if only one entry is given it is assumed to apply to all filters listed. "[True, False]"

filter.comments

filter.comments Description Example

Required: False

Units: None

Type: string

Style: name

Default: None

Any comments on filters. low pass is not calibrated

positive.id

positive.id Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Instrument ID number can be serial number or a designated ID. mt01

positive.manufacturer

positive.manufacturer Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Who manufactured the instrument. mt gurus

positive.type

positive.type Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Description of the instrument type. broadband 32-bit

positive.model

positive.model Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

Model version of the instrument. falcon5

positive.name

positive.name Description Example

Required: False

Units: None

Type: string

Style: free form

Default: None

Standard marketing name of the instrument. falcon5

positive.latitude

positive.latitude Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level 23.134

positive.longitude

positive.longitude Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level 14.23

positive.elevation

positive.elevation Description Example

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level 123.4

positive.latitude_uncertainty

positive.latitude_uncertainty Description Example

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees 0.01

positive.longitude_uncertainty

positive.longitude_uncertainty Description Example

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees 0.01

positive.elevation_uncertainty

positive.elevation_uncertainty Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation 0.01

positive.datum

positive.datum Description Example

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

Datum of the location values. Usually a well known datum like WGS84. WGS84

positive.x

positive.x Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

positive.x2

positive.x2 Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

positive.y

positive.y Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

positive.y2

positive.y2 Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

positive.z

positive.z Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station 10.0

positive.z2

positive.z2 Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station 10.0

positive.x_uncertainty

positive.x_uncertainty Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction 0.01

positive.y_uncertainty

positive.y_uncertainty Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction 0.01

positive.z_uncertainty

positive.z_uncertainty Description Example

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction 0.01

negative.id

negative.id Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Instrument ID number can be serial number or a designated ID. mt01

negative.manufacturer

negative.manufacturer Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Who manufactured the instrument. mt gurus

negative.type

negative.type Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Description of the instrument type. broadband 32-bit

negative.model

negative.model Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Model version of the instrument. falcon5

negative.name

negative.name Description Example

Required: True

Units: None

Type: string

Style: free form

Default: None

Standard marketing name of the instrument. falcon5

negative.latitude

negative.latitude Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level 23.134

negative.longitude

negative.longitude Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level 14.23

negative.elevation

negative.elevation Description Example

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level 123.4

negative.latitude_uncertainty

negative.latitude_uncertainty Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees 0.01

negative.longitude_uncertainty

negative.longitude_uncertainty Description Example

Required: True

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees 0.01

negative.elevation_uncertainty

negative.elevation_uncertainty Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation 0.01

negative.datum

negative.datum Description Example

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: None

Datum of the location values. Usually a well known datum like WGS84. WGS84

negative.x

negative.x Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

negative.x2

negative.x2 Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

negative.y

negative.y Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

negative.y2

negative.y2 Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station 10.0

negative.z

negative.z Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station 10.0

negative.z2

negative.z2 Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station 10.0

negative.x_uncertainty

negative.x_uncertainty Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction 0.01

negative.y_uncertainty

negative.y_uncertainty Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction 0.01

negative.z_uncertainty

negative.z_uncertainty Description Example

Required: True

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction 0.01

time_period.end

time_period.end Description Example

Required: True

Units: None

Type: string

Style: time

Default: 1980-01-01T00:00:00+00:00

End date and time of collection in UTC. 2020-02-04T16:2 3:45.453670+00: 00

time_period.start

time_period.start Description Example

Required: True

Units: None

Type: string

Style: time

Default: 1980-01-01T00:00:00+00:00

Start date and time of collection in UTC. 2020-02-01T09:2 3:45.453670+00: 00