mt_metadata.transfer_functions.io.jfiles.metadata package

Subpackages

Submodules

mt_metadata.transfer_functions.io.jfiles.metadata.birrp_angles module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.jfiles.metadata.birrp_angles.BirrpAngles(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

theta1

Required: True

Units: degrees

Type: float

Style: free form

Default: 0.0

rotation angle for block x

0

theta2

Required: True

Units: degrees

Type: float

Style: free form

Default: 0.0

rotation angle for block y

90

phi

Required: True

Units: degrees

Type: float

Style: free form

Default: 0.0

rotation angle for block

0

mt_metadata.transfer_functions.io.jfiles.metadata.birrp_block module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.jfiles.metadata.birrp_block.BirrpBlock(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

filnam

Required: True

Units: None

Type: string

Style: free form

Default: None

File name of data block

hx.dat

nskip

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of points to skip

0

nread

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of points to read

10000

ncomp

Required: True

Units: None

Type: integer

Style: number list

Default: []

number of components in file

4

indices

Required: True

Units: None

Type: integer

Style: number list

Default: []

index values to use

[1, 2]

mt_metadata.transfer_functions.io.jfiles.metadata.birrp_parameters module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.jfiles.metadata.birrp_parameters.BirrpParameters(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

outputs

Required: True

Units: None

Type: integer

Style: number

Default: 0

Number of output channels

2

inputs

Required: True

Units: None

Type: integer

Style: number

Default: 0

Number of input channels

2

references

Required: True

Units: None

Type: integer

Style: number

Default: 0

Number of reference channels

2

tbw

Required: True

Units: None

Type: float

Style: number

Default: 0.0

total bandwidth of window

2.0

deltat

Required: True

Units: None

Type: float

Style: number

Default: 0.0

sampling spacing, if negative sample rate.

1.0

nfft

Required: True

Units: None

Type: float

Style: number

Default: 0.0

length of time window.

8192

nsctinc

Required: True

Units: None

Type: float

Style: number

Default: 0.0

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

2.0

nsctmax

Required: True

Units: None

Type: float

Style: number

Default: 0.0

maximum number of sections

2.0

nf1

Required: True

Units: None

Type: integer

Style: number

Default: 0

index of first frequency

4

nfinc

Required: True

Units: None

Type: integer

Style: number

Default: 0

increment value of next frequency

2

nfsect

Required: True

Units: None

Type: integer

Style: number

Default: 0

total number of frequencies to process.

4

uin

Required: True

Units: None

Type: float

Style: number

Default: 0.0

small leverage point minimum

0.00

ainlin

Required: True

Units: None

Type: float

Style: number

Default: 0.0

bounded influence value

-999

ainuin

Required: True

Units: None

Type: float

Style: number

Default: 0.0

large leverage point minimu

0.99

c2threshe

Required: True

Units: None

Type: float

Style: number

Default: 0.0

coherencey threshold for electric channels

0.35

nz

Required: True

Units: None

Type: integer

Style: number

Default: 0

Use threshold for hz channels

0

c2threshe1

Required: True

Units: None

Type: float

Style: number

Default: 0.0

coherencey threshold for hz channels

0.35

npcs

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of data segments used

2

nar

Required: True

Units: None

Type: integer

Style: number

Default: 0

order of auto-regressive prewhitening filter.

5

imode

Required: True

Units: None

Type: integer

Style: number

Default: 0

input data file mode

0

jmode

Required: True

Units: None

Type: integer

Style: number

Default: 0

input time mode

0

ncomp

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of components

5

mt_metadata.transfer_functions.io.jfiles.metadata.header module

Created on Sat Dec 4 12:09:13 2021

@author: jpeacock

class mt_metadata.transfer_functions.io.jfiles.metadata.header.Header(**kwargs)[source]

Bases: Location

read_header(j_lines)[source]

Parsing the header lines of a j-file to extract processing information.

Input: - j-file as list of lines (output of readlines())

Output: - Dictionary with all parameters found

read_metadata(j_lines)[source]

read in the metadata of the station, or information of station logistics like: lat, lon, elevation

Not really needed for a birrp output since all values are nan’s

Module contents

class mt_metadata.transfer_functions.io.jfiles.metadata.BirrpAngles(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

theta1

Required: True

Units: degrees

Type: float

Style: free form

Default: 0.0

rotation angle for block x

0

theta2

Required: True

Units: degrees

Type: float

Style: free form

Default: 0.0

rotation angle for block y

90

phi

Required: True

Units: degrees

Type: float

Style: free form

Default: 0.0

rotation angle for block

0
class mt_metadata.transfer_functions.io.jfiles.metadata.BirrpBlock(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

filnam

Required: True

Units: None

Type: string

Style: free form

Default: None

File name of data block

hx.dat

nskip

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of points to skip

0

nread

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of points to read

10000

ncomp

Required: True

Units: None

Type: integer

Style: number list

Default: []

number of components in file

4

indices

Required: True

Units: None

Type: integer

Style: number list

Default: []

index values to use

[1, 2]
class mt_metadata.transfer_functions.io.jfiles.metadata.BirrpParameters(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

outputs

Required: True

Units: None

Type: integer

Style: number

Default: 0

Number of output channels

2

inputs

Required: True

Units: None

Type: integer

Style: number

Default: 0

Number of input channels

2

references

Required: True

Units: None

Type: integer

Style: number

Default: 0

Number of reference channels

2

tbw

Required: True

Units: None

Type: float

Style: number

Default: 0.0

total bandwidth of window

2.0

deltat

Required: True

Units: None

Type: float

Style: number

Default: 0.0

sampling spacing, if negative sample rate.

1.0

nfft

Required: True

Units: None

Type: float

Style: number

Default: 0.0

length of time window.

8192

nsctinc

Required: True

Units: None

Type: float

Style: number

Default: 0.0

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

2.0

nsctmax

Required: True

Units: None

Type: float

Style: number

Default: 0.0

maximum number of sections

2.0

nf1

Required: True

Units: None

Type: integer

Style: number

Default: 0

index of first frequency

4

nfinc

Required: True

Units: None

Type: integer

Style: number

Default: 0

increment value of next frequency

2

nfsect

Required: True

Units: None

Type: integer

Style: number

Default: 0

total number of frequencies to process.

4

uin

Required: True

Units: None

Type: float

Style: number

Default: 0.0

small leverage point minimum

0.00

ainlin

Required: True

Units: None

Type: float

Style: number

Default: 0.0

bounded influence value

-999

ainuin

Required: True

Units: None

Type: float

Style: number

Default: 0.0

large leverage point minimu

0.99

c2threshe

Required: True

Units: None

Type: float

Style: number

Default: 0.0

coherencey threshold for electric channels

0.35

nz

Required: True

Units: None

Type: integer

Style: number

Default: 0

Use threshold for hz channels

0

c2threshe1

Required: True

Units: None

Type: float

Style: number

Default: 0.0

coherencey threshold for hz channels

0.35

npcs

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of data segments used

2

nar

Required: True

Units: None

Type: integer

Style: number

Default: 0

order of auto-regressive prewhitening filter.

5

imode

Required: True

Units: None

Type: integer

Style: number

Default: 0

input data file mode

0

jmode

Required: True

Units: None

Type: integer

Style: number

Default: 0

input time mode

0

ncomp

Required: True

Units: None

Type: integer

Style: number

Default: 0

number of components

5
class mt_metadata.transfer_functions.io.jfiles.metadata.Header(**kwargs)[source]

Bases: Location

read_header(j_lines)[source]

Parsing the header lines of a j-file to extract processing information.

Input: - j-file as list of lines (output of readlines())

Output: - Dictionary with all parameters found

read_metadata(j_lines)[source]

read in the metadata of the station, or information of station logistics like: lat, lon, elevation

Not really needed for a birrp output since all values are nan’s