Logo

General Information

  • Introduction
  • Architecture
  • Installation
  • Usage
  • Contributing
  • Credits
  • Changelog
  • Conventions
  • Time Series Metadata Examples

Basics of Metadata Structure

  • Usage

MetadataBase

  • Base Metadata Objects

Common Metadata

  • Common Metadata Objects

Features and Weights

  • Features
  • Weights and Weighting Specifications

Processing and Fourier Coefficients

  • Processing Steps
  • Aurora Processing
  • Fourier Coefficients

Time Series and Filters

  • Time Series
  • Time Series Filters
  • MT and StationXML Translation
  • Filters

Transfer Functions

  • Transfer Function
  • Transfer Functions Base
  • EMTFXML
  • EDI
  • Z-Files
  • J-Files
    • BirrpAngles
    • BirrpBlock
    • BirrpParameters
    • Header
      • latitude
      • longitude
      • elevation
      • datum
      • x
      • y
      • z
      • title
      • station
      • azimuth
      • birrp_parameters.outputs
      • birrp_parameters.inputs
      • birrp_parameters.references
      • birrp_parameters.tbw
      • birrp_parameters.deltat
      • birrp_parameters.nfft
      • birrp_parameters.nsctinc
      • birrp_parameters.nsctmax
      • birrp_parameters.nf1
      • birrp_parameters.nfinc
      • birrp_parameters.nfsect
      • birrp_parameters.uin
      • birrp_parameters.ainlin
      • birrp_parameters.ainuin
      • birrp_parameters.c2threshe
      • birrp_parameters.nz
      • birrp_parameters.c2threshe1
      • birrp_parameters.npcs
      • birrp_parameters.nar
      • birrp_parameters.imode
      • birrp_parameters.jmode
      • birrp_parameters.ncomp
      • data_blocks
      • angles
  • Zonge AVG

API Reference

  • API Reference
MT Metadata
  • J-Files
  • Header
  • View page source

Header

latitude

latitude

Description

Example

Required: False

Type: float | None

Units: degrees

Latitude of the location.

12.324

longitude

longitude

Description

Example

Required: False

Type: float | None

Units: degrees

Longitude of the location.

12.324

elevation

elevation

Description

Example

Required: False

Type: <class ‘float’>

Units: meters

Elevation of the location.

1234.0

datum

datum

Description

Example

Required: False

Type: str | int

Units: None

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

WGS 84

x

x

Description

Example

Required: False

Type: <class ‘float’>

Units: meters

relative distance to the center of the station

10.0

y

y

Description

Example

Required: False

Type: <class ‘float’>

Units: meters

relative distance to the center of the station

10.0

z

z

Description

Example

Required: False

Type: <class ‘float’>

Units: meters

relative elevation to the center of the station

10.0

title

title

Description

Example

Required: True

Type: <class ‘str’>

Units: None

title of file

BIRRP Version 5 basic mode output

station

station

Description

Example

Required: True

Type: <class ‘str’>

Units: None

station name

mt001

azimuth

azimuth

Description

Example

Required: True

Type: <class ‘float’>

Units: degrees

rotation of full impedance tensor

0

birrp_parameters.outputs

birrp_parameters.outputs

Description

Example

Required: True

Type: <class ‘int’>

Units: None

Number of output channels

2

birrp_parameters.inputs

birrp_parameters.inputs

Description

Example

Required: True

Type: <class ‘int’>

Units: None

Number of input channels

2

birrp_parameters.references

birrp_parameters.references

Description

Example

Required: True

Type: <class ‘int’>

Units: None

Number of reference channels

2

birrp_parameters.tbw

birrp_parameters.tbw

Description

Example

Required: True

Type: <class ‘float’>

Units: None

total bandwidth of window

2.0

birrp_parameters.deltat

birrp_parameters.deltat

Description

Example

Required: True

Type: <class ‘float’>

Units: None

sampling spacing, if negative sample rate.

1.0

birrp_parameters.nfft

birrp_parameters.nfft

Description

Example

Required: True

Type: <class ‘float’>

Units: None

length of time window.

8192

birrp_parameters.nsctinc

birrp_parameters.nsctinc

Description

Example

Required: True

Type: <class ‘float’>

Units: None

number by which the segment length is divided by to get next window.

2.0

birrp_parameters.nsctmax

birrp_parameters.nsctmax

Description

Example

Required: True

Type: <class ‘float’>

Units: None

maximum number of sections

2.0

birrp_parameters.nf1

birrp_parameters.nf1

Description

Example

Required: True

Type: <class ‘int’>

Units: None

index of first frequency

4

birrp_parameters.nfinc

birrp_parameters.nfinc

Description

Example

Required: True

Type: <class ‘int’>

Units: None

increment value of next frequency

2

birrp_parameters.nfsect

birrp_parameters.nfsect

Description

Example

Required: True

Type: <class ‘int’>

Units: None

total number of frequencies to process.

4

birrp_parameters.uin

birrp_parameters.uin

Description

Example

Required: True

Type: <class ‘float’>

Units: None

small leverage point minimum

0.00

birrp_parameters.ainlin

birrp_parameters.ainlin

Description

Example

Required: True

Type: <class ‘float’>

Units: None

bounded influence value

-999

birrp_parameters.ainuin

birrp_parameters.ainuin

Description

Example

Required: True

Type: <class ‘float’>

Units: None

large leverage point minimu

0.99

birrp_parameters.c2threshe

birrp_parameters.c2threshe

Description

Example

Required: True

Type: <class ‘float’>

Units: None

coherencey threshold for electric channels

0.35

birrp_parameters.nz

birrp_parameters.nz

Description

Example

Required: True

Type: <class ‘int’>

Units: None

Use threshold for hz channels

0

birrp_parameters.c2threshe1

birrp_parameters.c2threshe1

Description

Example

Required: True

Type: <class ‘float’>

Units: None

coherencey threshold for hz channels

0.35

birrp_parameters.npcs

birrp_parameters.npcs

Description

Example

Required: True

Type: <class ‘int’>

Units: None

number of data segments used

2

birrp_parameters.nar

birrp_parameters.nar

Description

Example

Required: True

Type: <class ‘int’>

Units: None

order of auto-regressive prewhitening filter.

5

birrp_parameters.imode

birrp_parameters.imode

Description

Example

Required: True

Type: <class ‘int’>

Units: None

input data file mode

0

birrp_parameters.jmode

birrp_parameters.jmode

Description

Example

Required: True

Type: <class ‘int’>

Units: None

input time mode

0

birrp_parameters.ncomp

birrp_parameters.ncomp

Description

Example

Required: True

Type: <class ‘int’>

Units: None

number of components

5

data_blocks

data_blocks

Description

Example

Required: True

Type: list[mt_metadata.transfer_functions .io.jfiles.metadata.birrp_block.Bir Units: None

BIRRP data blocks

BirrpBlock(…)

angles

angles

Description

Example

Required: True

Type: list[mt_metadata.transfer_functions .io.jfiles.metadata.birrp_angles.Bi Units: None

BIRRP angles

BirrpAngles(… )

Previous Next

© Copyright 2020, Jared Peacock.

Built with Sphinx using a theme provided by Read the Docs.