mt_metadata.transfer_functions.io.emtfxml.metadata package

Subpackages

Submodules

mt_metadata.transfer_functions.io.emtfxml.metadata.attachment module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.attachment.Attachment(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

filename

Required: True

Units: None

Type: string

Style: free form

Default: None

file name of the attached file data

example.zmm

description

Required: True

Units: None

Type: string

Style: free form

Default: None

description of the attached file

The original used to produce the XML
read_dict(input_dict)[source]
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.channels module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.channels.Channels(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

ref

Required: True

Units: None

Type: string

Style: free form

Default: None

reference to the site name

site

units

Required: True

Units: None

Type: string

Style: free form

Default: None

units of the distance coordinates

site

mt_metadata.transfer_functions.io.emtfxml.metadata.citation module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.citation.Citation(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

title

Required: False

Units: None

Type: string

Style: free form

Default: None

Full title of the citation

Paper Title

authors

Required: False

Units: None

Type: string

Style: free form

Default: None

author names

M.Tee A. Roura

year

Required: False

Units: None

Type: string

Style: date

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

Year of citation

2020

volume

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal volume of the citation

12

pages

Required: False

Units: None

Type: string

Style: free form

Default: None

Page numbers of the citation

10-15

journal

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal title of citation

Journal of Geophysical Research

doi

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the citation

###/###

survey_d_o_i

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the survey

###/###
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.comment module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.comment.Comment(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
property date
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]

mt_metadata.transfer_functions.io.emtfxml.metadata.copyright module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.copyright.Copyright(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

selected_publications

Required: False

Units: None

Type: string

Style: free form

Default: None

Any publications that use this data

my paper

release_status

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: Unrestricted Release

the release status of the data

Unrestricted release

conditions_of_use

Required: True

Units: None

Type: string

Style: free form

Default: All data and metadata for this survey are available free of charge and may be copied freely, duplicated and further distributed provided this data set is cited as the reference. While the author(s) strive to provide data and metadata of best possible quality, neither the author(s) of this data set, not IRIS make any claims, promises, or guarantees about the accuracy, completeness, or adequacy of this information, and expressly disclaim liability for errors and omissions in the contents of this file. Guidelines about the quality or limitations of the data and metadata, as obtained from the author(s), are included for informational purposes only.

Any notes on conditions of use

Cite data upon usage.

acknowledgement

Required: False

Units: None

Type: string

Style: free form

Default: None

any acknowledgments the transfer function should have.

This project was funded by x.

additional_info

Required: False

Units: None

Type: string

Style: free form

Default: None

any additional information about the data.

This purpose of this project is …

citation.title

Required: False

Units: None

Type: string

Style: free form

Default: None

Full title of the citation

Paper Title

citation.authors

Required: False

Units: None

Type: string

Style: free form

Default: None

author names

M.Tee A. Roura

citation.year

Required: False

Units: None

Type: string

Style: date

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

Year of citation

2020

citation.volume

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal volume of the citation

12

citation.pages

Required: False

Units: None

Type: string

Style: free form

Default: None

Page numbers of the citation

10-15

citation.journal

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal title of citation

Journal of Geophysical Research

citation.doi

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the citation

###/###

citation.survey_d_o_i

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the survey

###/###
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]

mt_metadata.transfer_functions.io.emtfxml.metadata.data module

Created on Mon Sep 6 13:53:55 2021

@author: jpeacock

class mt_metadata.transfer_functions.io.emtfxml.metadata.data.TransferFunction[source]

Bases: Base

Deal with the complex XML format

property array_dict
initialize_arrays(n_periods)[source]
property n_periods
property period

periods for estimates

read_block(block, period_index)[source]

Read a period block which is root_dict[“data”][“period”][ii]

Parameters:

block (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

read_dict(root_dict)[source]

read root_dict[“data”] :param root_dict: DESCRIPTION :type root_dict: TYPE :return: DESCRIPTION :rtype: TYPE

property t

ts for estimates

property t_invsigcov

t_invsigcov for estimates

property t_residcov

t_residcov for estimates

property t_var

t_var for estimates

to_xml(string=False, required=True)[source]

Write data blocks

Parameters:

parent (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

write_block(parent, index)[source]

Write a data block

Parameters:

parent (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property z

zs for estimates

property z_invsigcov

z_invsigcov for estimates

property z_residcov

z_residcov for estimates

property z_var

z_var for estimates

mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_notes module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_notes.DataQualityNotes(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

good_from_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number

0.01

good_to_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number

1000

rating

Required: False

Units: None

Type: integer

Style: number

Default: None

Rating of the data from 0 to 5 where 5 is the best and 0 is unrated

4

comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_warnings module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_warnings.DataQualityWarnings(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

flag

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality

0
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.data_type module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.data_type.DataType(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the statistical estimate

var

type

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: real

Type of number contained in the estimate

real

description

Required: True

Units: None

Type: string

Style: free form

Default: None

Description of the statistical estimate

this is an estimate

external_url

Required: True

Units: None

Type: string

Style: url

Default: None

Full path to external link that has additional information

http://www.iris .edu/dms/produc ts/emtf/varianc e.html

intention

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: error estimate

The intension of the statistical estimate

error estimate

tag

Required: True

Units: None

Type: string

Style: free form

Default: None

A useful tag for the estimate

tipper

output

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: E

Type of output channels in data type

E

input

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: E

Type of input channels in data type

E

units

Required: True

Units: None

Type: string

Style: free form

Default: None

Units for the data type

[mV/km]/[nT]
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.data_types module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.data_types.DataTypes(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

data_types_list

Required: True

Units: None

Type: string

Style: name list

Default: []

list of data types

[Z T]
property data_types_list
read_dict(input_dict)[source]

Read in statistical estimate descriptions

Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.dipole module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.dipole.Dipole(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

manfacturer

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the manufacturer of the instrument

MT Gurus

length

Required: False

Units: meters

Type: float

Style: number

Default: None

Dipole length

10

azimuth

Required: False

Units: degrees

Type: float

Style: number

Default: None

Azimuth of the dipole relative to coordinate system

90

name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the dipole

ex

type

Required: False

Units: None

Type: string

Style: free form

Default: None

type of dipole

wire
property electrode
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.electric module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.electric.Electric(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the channel

hx

orientation

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

orientation angle relative to geographic north

11.9

x

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of negative sensor relative center point in north direction

100.0

x2

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of positive sensor relative center point in north direction

100.0

y

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of negative sensor relative center point in east direction

100.0

y2

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of positive sensor relative center point in east direction

100.0

z

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of negative sensor relative center point in depth

100.0

z2

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of positive sensor relative center point in depth

100.0
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.electrode module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.electrode.Electrode(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

location

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: None

Direction of electrode

N

number

Required: True

Units: None

Type: string

Style: free form

Default: 0

Electrode ID number

1a

comments

Required: True

Units: None

Type: string

Style: free form

Default: None

comments on the electrode

Ag-AgCl porous pot
property comments
to_xml(string=False, required=False)[source]

mt_metadata.transfer_functions.io.emtfxml.metadata.emtf module

Created on Sat Sep 4 18:21:25 2021

@author: jpeacock

class mt_metadata.transfer_functions.io.emtfxml.metadata.emtf.EMTF(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

description

Required: True

Units: None

Type: string

Style: free form

Default: None

description of what is in the file; default is magnetotelluric transfer functions

Magnetotelluric Transfer Functions

product_id

Required: True

Units: None

Type: string

Style: alpha numeric

Default: None

ID given as the archive ID of the station

USMTArray.NVS11 .2020

tags

Required: True

Units: None

Type: string

Style: free form

Default: None

tags that help describe the data

impedance, induction vectors

sub_type

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: MT_TF

subject data type

MT_TF

notes

Required: False

Units: None

Type: string

Style: free form

Default: None

any notes applicable to the user on data present in the file

these are notes

mt_metadata.transfer_functions.io.emtfxml.metadata.estimate module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.estimate.Estimate(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the statistical estimate

var

type

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: real

Type of number contained in the estimate

real

description

Required: True

Units: None

Type: string

Style: free form

Default: None

Description of the statistical estimate

this is an estimate

external_url

Required: True

Units: None

Type: string

Style: url

Default: None

Full path to external link that has additional information

http://www.iris .edu/dms/produc ts/emtf/varianc e.html

intention

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: error estimate

The intension of the statistical estimate

error estimate

tag

Required: True

Units: None

Type: string

Style: free form

Default: None

A useful tag for the estimate

tipper
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.external_url module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.external_url.ExternalUrl(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

description

Required: True

Units: None

Type: string

Style: free form

Default: None

description of where the external URL points towards

IRIS DMC Metadata

url

Required: True

Units: None

Type: string

Style: url

Default: None

full URL of where the data is stored

http://www.iris .edu/mda/EM/NVS 11
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.field_notes module

Created on Thu Mar 9 12:25:44 2023

@author: jpeacock

class mt_metadata.transfer_functions.io.emtfxml.metadata.field_notes.FieldNotes(**kwargs)[source]

Bases: Base

read_dict(input_dict)[source]
property run_list
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.magnetic module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.magnetic.Magnetic(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the channel

hx

orientation

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

orientation angle relative to geographic north

11.9

x

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of sensor relative center point in north direction

100.0

y

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of sensor relative center point in east direction

100.0

z

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of sensor relative center point in depth

100.0
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.magnetometer module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.magnetometer.Magnetometer(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

id

Required: True

Units: None

Type: string

Style: free form

Default: None

instrument ID number can be serial number or a designated ID

mt01

manufacturer

Required: True

Units: None

Type: string

Style: free form

Default: None

who manufactured the instrument

mt gurus

type

Required: True

Units: None

Type: string

Style: free form

Default: None

instrument type

broadband 32-bit

model

Required: False

Units: None

Type: string

Style: free form

Default: None

model version of the instrument

falcon5

name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the model of the instrument

falcon5

settings

Required: False

Units: None

Type: string

Style: free form

Default: None

Any settings for the instrument

notch filter applied
to_xml(string=False, required=False)[source]

mt_metadata.transfer_functions.io.emtfxml.metadata.period_range module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.period_range.PeriodRange(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

min

Required: True

Units: samples per second

Type: float

Style: number

Default: 0.0

minimum period

“4.5E-5”

max

Required: True

Units: samples per second

Type: float

Style: number

Default: 0.0

maxmimu period

“4.5E5”
read_dict(input_dict)[source]
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.person module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.person.Person(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

author name

person name

email

Required: True

Units: None

Type: string

Style: email

Default: None

email of the contact person

mt.guru@em.org

org

Required: True

Units: None

Type: string

Style: free form

Default: None

organization name

mt gurus

org_url

Required: False

Units: None

Type: string

Style: url

Default: None

URL of organization

https://www.mt_ gurus.org

mt_metadata.transfer_functions.io.emtfxml.metadata.primary_data module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.primary_data.PrimaryData(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

filename

Required: True

Units: None

Type: string

Style: free form

Default: None

file name of the figure file that displays the data

example.png
read_dict(input_dict)[source]

mt_metadata.transfer_functions.io.emtfxml.metadata.processing_info module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.processing_info.ProcessingInfo(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

sign_convention

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: exp(+ iomega t)

Sign convention of the processing software output

exp(+ iomega t)

processed_by

Required: False

Units: None

Type: string

Style: free form

Default: None

Names of people who processed the data

MT Guru

process_date

Required: False

Units: None

Type: string

Style: date

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

Date the data were processed

2020-01-01

processing_tag

Required: False

Units: None

Type: string

Style: free form

Default: None

List of remote references

mt001-mt002

processing_software.name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the software used for processing

EMTF

processing_software.last_mod

Required: False

Units: None

Type: string

Style: date

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

Date the software was last modified

2020-01-01

processing_software.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author of the software used for processing

MT Guru

remote_ref.type

Required: True

Units: None

Type: string

Style: free form

Default: none

type of remote referencing

robust multi- station remote referencing

remote_info.site.project

Required: False

Units: None

Type: string

Style: alpha numeric

Default: None

Name of the project

USMTArray

remote_info.site.survey

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the survey

MT 2020

remote_info.site.year_collected

Required: False

Units: None

Type: integer

Style: number

Default: 1980

Year data collected

2020

remote_info.site.country

Required: False

Units: None

Type: string

Style: free form

Default: None

Country where data was collected

USA

remote_info.site.id

Required: False

Units: None

Type: string

Style: alpha numeric

Default: None

Station ID name. This should be an alpha numeric name that is typically 5-6 characters long. Commonly the project name in 2 or 3 letters and the station number.

MT001

remote_info.site.name

Required: False

Units: None

Type: string

Style: free form

Default: None

closest geographic name to the station

“Whitehorse, YK”

remote_info.site.acquired_by

Required: False

Units: None

Type: string

Style: free form

Default: None

Person or group who collected the data

MT Group

remote_info.site.start

Required: False

Units: None

Type: string

Style: date time

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

Date time when the data collection started

2020-01-01T12:0 0:00

remote_info.site.end

Required: False

Units: None

Type: string

Style: date time

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

Date time when the data collection ended

2020-05-01T12:0 0:00

remote_info.site.run_list

Required: False

Units: None

Type: string

Style: name list

Default: []

list of runs recorded by the station. Should be a summary of all runss recorded

“[ mt001a, mt001b, mt001c ]”

remote_info.site.location.latitude

Required: False

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level

23.134

remote_info.site.location.longitude

Required: False

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level

14.23

remote_info.site.location.elevation

Required: False

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level

123.4

remote_info.site.location.latitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees

0.01

remote_info.site.location.longitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees

0.01

remote_info.site.location.elevation_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation

0.01

remote_info.site.location.datum

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

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

WGS84

remote_info.site.location.x

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.x2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.y

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.y2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.z

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

remote_info.site.location.z2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

remote_info.site.location.x_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction

0.01

remote_info.site.location.y_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction

0.01

remote_info.site.location.z_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction

0.01

remote_info.site.orientation.angle_to_geographic_north

Required: False

Units: degrees

Type: float

Style: number

Default: 0.0

Angle to geographic north of the station orientation

0

remote_info.site.orientation.layout

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: orthogonal

Orientation of channels relative to each other

orthogonal

remote_info.site.data_quality_notes.good_from_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number

0.01

remote_info.site.data_quality_notes.good_to_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number

1000

remote_info.site.data_quality_notes.rating

Required: False

Units: None

Type: integer

Style: number

Default: None

Rating of the data from 0 to 5 where 5 is the best and 0 is unrated

4

remote_info.site.data_quality_notes.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

remote_info.site.data_quality_notes.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

remote_info.site.data_quality_notes.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment

remote_info.site.data_quality_warnings.flag

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality

0

remote_info.site.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

remote_info.site.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

remote_info.site.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
property process_date
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.provenance module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.provenance.Provenance(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

create_time

Required: True

Units: None

Type: string

Style: date time

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

date and time the file was created

2020-02-08T12:2 3:40.324600+00: 00

creating_application

Required: True

Units: None

Type: string

Style: free form

Default: mt_metadata

name of the application that created the XML file

EMTF File Conversion Utilities 4.0

creator.name

Required: True

Units: None

Type: string

Style: free form

Default: None

author name

person name

creator.email

Required: True

Units: None

Type: string

Style: email

Default: None

email of the contact person

mt.guru@em.org

creator.org

Required: True

Units: None

Type: string

Style: free form

Default: None

organization name

mt gurus

creator.org_url

Required: False

Units: None

Type: string

Style: url

Default: None

URL of organization

https://www.mt_ gurus.org

submitter.name

Required: True

Units: None

Type: string

Style: free form

Default: None

author name

person name

submitter.email

Required: True

Units: None

Type: string

Style: email

Default: None

email of the contact person

mt.guru@em.org

submitter.org

Required: True

Units: None

Type: string

Style: free form

Default: None

organization name

mt gurus

submitter.org_url

Required: False

Units: None

Type: string

Style: url

Default: None

URL of organization

https://www.mt_ gurus.org
property create_time
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.remote_ref module

Created on Mon Sep 6 12:04:35 2021

@author: jpeacock

class mt_metadata.transfer_functions.io.emtfxml.metadata.remote_ref.RemoteRef(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

type

Required: True

Units: None

Type: string

Style: free form

Default: None

type of remote referencing

robust multi- station remote referencing
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.site module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.site.Site(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

project

Required: True

Units: None

Type: string

Style: alpha numeric

Default: None

Name of the project

USMTArray

survey

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the survey

MT 2020

year_collected

Required: True

Units: None

Type: integer

Style: number

Default: 1980

Year data collected

2020

country

Required: True

Units: None

Type: string

Style: free form

Default: None

Country where data was collected

USA

id

Required: True

Units: None

Type: string

Style: alpha numeric

Default: None

Station ID name. This should be an alpha numeric name that is typically 5-6 characters long. Commonly the project name in 2 or 3 letters and the station number.

MT001

name

Required: True

Units: None

Type: string

Style: free form

Default: None

closest geographic name to the station

“Whitehorse, YK”

acquired_by

Required: True

Units: None

Type: string

Style: free form

Default: None

Person or group who collected the data

MT Group

start

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection started

2020-01-01T12:0 0:00

end

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection ended

2020-05-01T12:0 0:00

run_list

Required: True

Units: None

Type: string

Style: name list

Default: []

list of runs recorded by the station. Should be a summary of all runss recorded

“[ mt001a, mt001b, mt001c ]”

location.latitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level

23.134

location.longitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level

14.23

location.elevation

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level

123.4

location.latitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees

0.01

location.longitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees

0.01

location.elevation_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation

0.01

location.datum

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

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

WGS84

location.x

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.x2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.y

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.y2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.z

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

location.z2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

location.x_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction

0.01

location.y_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction

0.01

location.z_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction

0.01

orientation.angle_to_geographic_north

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

Angle to geographic north of the station orientation

0

orientation.layout

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: orthogonal

Orientation of channels relative to each other

orthogonal

data_quality_notes.good_from_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number

0.01

data_quality_notes.good_to_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number

1000

data_quality_notes.rating

Required: False

Units: None

Type: integer

Style: number

Default: None

Rating of the data from 0 to 5 where 5 is the best and 0 is unrated

4

data_quality_notes.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

data_quality_notes.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

data_quality_notes.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment

data_quality_warnings.flag

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality

0

comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
property end
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property run_list
property start
to_xml(string=False, required=True)[source]
property year_collected

mt_metadata.transfer_functions.io.emtfxml.metadata.site_layout module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.site_layout.SiteLayout(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

input_channels

Required: True

Units: None

Type: string

Style: name list

Default: []

list of input channels for transfer function estimation

[Magnetic(hx), Magnetic(hy)]

output_channels

Required: True

Units: None

Type: string

Style: name list

Default: []

list of output channels for transfer function estimation

[Electric(ex), Electric(ey), Magnetic(hz)]
property input_channel_names
property input_channels
property output_channel_names
property output_channels
read_dict(input_dict)[source]

read site layout into the proper input/output channels

Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.software module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.software.ProcessingSoftware(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the software used for processing

EMTF

last_mod

Required: False

Units: None

Type: string

Style: date

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

Date the software was last modified

2020-01-01

author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author of the software used for processing

MT Guru
property last_mod
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

mt_metadata.transfer_functions.io.emtfxml.metadata.statistical_estimates module

Created on Wed Dec 23 21:30:36 2020

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.statistical_estimates.StatisticalEstimates(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

estimates_list

Required: True

Units: None

Type: string

Style: name list

Default: []

list of statistical estimates

[var cov]
property estimates_list
read_dict(input_dict)[source]

Read in statistical estimate descriptions

Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

Module contents

EMTF XML metadata

The metadata for transfer functions follows those proposed by Anna Kelbert EMTF XML: New data interchange format and conversion tools for electromagnetic transfer functions.

copyright:

Jared Peacock (jpeacock@usgs.gov)

license:

MIT

class mt_metadata.transfer_functions.io.emtfxml.metadata.Attachment(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

filename

Required: True

Units: None

Type: string

Style: free form

Default: None

file name of the attached file data

example.zmm

description

Required: True

Units: None

Type: string

Style: free form

Default: None

description of the attached file

The original used to produce the XML
read_dict(input_dict)[source]
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Channels(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

ref

Required: True

Units: None

Type: string

Style: free form

Default: None

reference to the site name

site

units

Required: True

Units: None

Type: string

Style: free form

Default: None

units of the distance coordinates

site
class mt_metadata.transfer_functions.io.emtfxml.metadata.Citation(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

title

Required: False

Units: None

Type: string

Style: free form

Default: None

Full title of the citation

Paper Title

authors

Required: False

Units: None

Type: string

Style: free form

Default: None

author names

M.Tee A. Roura

year

Required: False

Units: None

Type: string

Style: date

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

Year of citation

2020

volume

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal volume of the citation

12

pages

Required: False

Units: None

Type: string

Style: free form

Default: None

Page numbers of the citation

10-15

journal

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal title of citation

Journal of Geophysical Research

doi

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the citation

###/###

survey_d_o_i

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the survey

###/###
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Comment(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
property date
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
class mt_metadata.transfer_functions.io.emtfxml.metadata.Copyright(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

selected_publications

Required: False

Units: None

Type: string

Style: free form

Default: None

Any publications that use this data

my paper

release_status

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: Unrestricted Release

the release status of the data

Unrestricted release

conditions_of_use

Required: True

Units: None

Type: string

Style: free form

Default: All data and metadata for this survey are available free of charge and may be copied freely, duplicated and further distributed provided this data set is cited as the reference. While the author(s) strive to provide data and metadata of best possible quality, neither the author(s) of this data set, not IRIS make any claims, promises, or guarantees about the accuracy, completeness, or adequacy of this information, and expressly disclaim liability for errors and omissions in the contents of this file. Guidelines about the quality or limitations of the data and metadata, as obtained from the author(s), are included for informational purposes only.

Any notes on conditions of use

Cite data upon usage.

acknowledgement

Required: False

Units: None

Type: string

Style: free form

Default: None

any acknowledgments the transfer function should have.

This project was funded by x.

additional_info

Required: False

Units: None

Type: string

Style: free form

Default: None

any additional information about the data.

This purpose of this project is …

citation.title

Required: False

Units: None

Type: string

Style: free form

Default: None

Full title of the citation

Paper Title

citation.authors

Required: False

Units: None

Type: string

Style: free form

Default: None

author names

M.Tee A. Roura

citation.year

Required: False

Units: None

Type: string

Style: date

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

Year of citation

2020

citation.volume

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal volume of the citation

12

citation.pages

Required: False

Units: None

Type: string

Style: free form

Default: None

Page numbers of the citation

10-15

citation.journal

Required: False

Units: None

Type: string

Style: free form

Default: None

Journal title of citation

Journal of Geophysical Research

citation.doi

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the citation

###/###

citation.survey_d_o_i

Required: False

Units: None

Type: string

Style: url

Default: None

doi number of the survey

###/###
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
class mt_metadata.transfer_functions.io.emtfxml.metadata.DataQualityNotes(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

good_from_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number

0.01

good_to_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number

1000

rating

Required: False

Units: None

Type: integer

Style: number

Default: None

Rating of the data from 0 to 5 where 5 is the best and 0 is unrated

4

comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.DataQualityWarnings(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

flag

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality

0
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.DataType(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the statistical estimate

var

type

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: real

Type of number contained in the estimate

real

description

Required: True

Units: None

Type: string

Style: free form

Default: None

Description of the statistical estimate

this is an estimate

external_url

Required: True

Units: None

Type: string

Style: url

Default: None

Full path to external link that has additional information

http://www.iris .edu/dms/produc ts/emtf/varianc e.html

intention

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: error estimate

The intension of the statistical estimate

error estimate

tag

Required: True

Units: None

Type: string

Style: free form

Default: None

A useful tag for the estimate

tipper

output

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: E

Type of output channels in data type

E

input

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: E

Type of input channels in data type

E

units

Required: True

Units: None

Type: string

Style: free form

Default: None

Units for the data type

[mV/km]/[nT]
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.DataTypes(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

data_types_list

Required: True

Units: None

Type: string

Style: name list

Default: []

list of data types

[Z T]
property data_types_list
read_dict(input_dict)[source]

Read in statistical estimate descriptions

Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Dipole(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

manfacturer

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the manufacturer of the instrument

MT Gurus

length

Required: False

Units: meters

Type: float

Style: number

Default: None

Dipole length

10

azimuth

Required: False

Units: degrees

Type: float

Style: number

Default: None

Azimuth of the dipole relative to coordinate system

90

name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the dipole

ex

type

Required: False

Units: None

Type: string

Style: free form

Default: None

type of dipole

wire
property electrode
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.EMTF(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

description

Required: True

Units: None

Type: string

Style: free form

Default: None

description of what is in the file; default is magnetotelluric transfer functions

Magnetotelluric Transfer Functions

product_id

Required: True

Units: None

Type: string

Style: alpha numeric

Default: None

ID given as the archive ID of the station

USMTArray.NVS11 .2020

tags

Required: True

Units: None

Type: string

Style: free form

Default: None

tags that help describe the data

impedance, induction vectors

sub_type

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: MT_TF

subject data type

MT_TF

notes

Required: False

Units: None

Type: string

Style: free form

Default: None

any notes applicable to the user on data present in the file

these are notes
class mt_metadata.transfer_functions.io.emtfxml.metadata.Electric(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the channel

hx

orientation

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

orientation angle relative to geographic north

11.9

x

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of negative sensor relative center point in north direction

100.0

x2

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of positive sensor relative center point in north direction

100.0

y

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of negative sensor relative center point in east direction

100.0

y2

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of positive sensor relative center point in east direction

100.0

z

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of negative sensor relative center point in depth

100.0

z2

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of positive sensor relative center point in depth

100.0
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Electrode(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

location

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: None

Direction of electrode

N

number

Required: True

Units: None

Type: string

Style: free form

Default: 0

Electrode ID number

1a

comments

Required: True

Units: None

Type: string

Style: free form

Default: None

comments on the electrode

Ag-AgCl porous pot
property comments
to_xml(string=False, required=False)[source]
class mt_metadata.transfer_functions.io.emtfxml.metadata.Estimate(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the statistical estimate

var

type

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: real

Type of number contained in the estimate

real

description

Required: True

Units: None

Type: string

Style: free form

Default: None

Description of the statistical estimate

this is an estimate

external_url

Required: True

Units: None

Type: string

Style: url

Default: None

Full path to external link that has additional information

http://www.iris .edu/dms/produc ts/emtf/varianc e.html

intention

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: error estimate

The intension of the statistical estimate

error estimate

tag

Required: True

Units: None

Type: string

Style: free form

Default: None

A useful tag for the estimate

tipper
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.ExternalUrl(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

description

Required: True

Units: None

Type: string

Style: free form

Default: None

description of where the external URL points towards

IRIS DMC Metadata

url

Required: True

Units: None

Type: string

Style: url

Default: None

full URL of where the data is stored

http://www.iris .edu/mda/EM/NVS 11
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.FieldNotes(**kwargs)[source]

Bases: Base

read_dict(input_dict)[source]
property run_list
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Instrument(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

id

Required: True

Units: None

Type: string

Style: free form

Default: None

instrument ID number can be serial number or a designated ID

mt01

manufacturer

Required: True

Units: None

Type: string

Style: free form

Default: None

who manufactured the instrument

mt gurus

type

Required: True

Units: None

Type: string

Style: free form

Default: None

instrument type

broadband 32-bit

model

Required: False

Units: None

Type: string

Style: free form

Default: None

model version of the instrument

falcon5

name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the model of the instrument

falcon5

settings

Required: False

Units: None

Type: string

Style: free form

Default: None

Any settings for the instrument

notch filter applied
to_xml(string=False, required=False)[source]
class mt_metadata.transfer_functions.io.emtfxml.metadata.Location(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

latitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level

23.134

longitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level

14.23

elevation

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level

123.4

latitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees

0.01

longitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees

0.01

elevation_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation

0.01

datum

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

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

WGS84

x

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

x2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

y

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

y2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

z

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

z2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

x_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction

0.01

y_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction

0.01

z_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction

0.01

declination.comments

Required: False

Units: None

Type: string

Style: free form

Default: None

any comments on declination

estimated from WMM 2016

declination.model

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: WMM

geomagnetic reference model used to calculate declination

WMM

declination.epoch

Required: False

Units: None

Type: string

Style: free form

Default: None

Epoch for which declination was approximated in.

2020

declination.value

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

declination angle relative to geographic north positive clockwise

12.3
property elevation
property latitude
property longitude
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]

Overwrite to XML to follow EMTF XML format

Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Magnetic(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the channel

hx

orientation

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

orientation angle relative to geographic north

11.9

x

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of sensor relative center point in north direction

100.0

y

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of sensor relative center point in east direction

100.0

z

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

location of sensor relative center point in depth

100.0
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Magnetometer(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

id

Required: True

Units: None

Type: string

Style: free form

Default: None

instrument ID number can be serial number or a designated ID

mt01

manufacturer

Required: True

Units: None

Type: string

Style: free form

Default: None

who manufactured the instrument

mt gurus

type

Required: True

Units: None

Type: string

Style: free form

Default: None

instrument type

broadband 32-bit

model

Required: False

Units: None

Type: string

Style: free form

Default: None

model version of the instrument

falcon5

name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the model of the instrument

falcon5

settings

Required: False

Units: None

Type: string

Style: free form

Default: None

Any settings for the instrument

notch filter applied
to_xml(string=False, required=False)[source]
class mt_metadata.transfer_functions.io.emtfxml.metadata.Orientation(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

angle_to_geographic_north

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

Angle to geographic north of the station orientation

0

layout

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: orthogonal

Orientation of channels relative to each other

orthogonal
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]

Overwrite to XML to follow EMTF XML format

Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.PeriodRange(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

min

Required: True

Units: samples per second

Type: float

Style: number

Default: 0.0

minimum period

“4.5E-5”

max

Required: True

Units: samples per second

Type: float

Style: number

Default: 0.0

maxmimu period

“4.5E5”
read_dict(input_dict)[source]
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Person(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: True

Units: None

Type: string

Style: free form

Default: None

author name

person name

email

Required: True

Units: None

Type: string

Style: email

Default: None

email of the contact person

mt.guru@em.org

org

Required: True

Units: None

Type: string

Style: free form

Default: None

organization name

mt gurus

org_url

Required: False

Units: None

Type: string

Style: url

Default: None

URL of organization

https://www.mt_ gurus.org
class mt_metadata.transfer_functions.io.emtfxml.metadata.PrimaryData(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

filename

Required: True

Units: None

Type: string

Style: free form

Default: None

file name of the figure file that displays the data

example.png
read_dict(input_dict)[source]
class mt_metadata.transfer_functions.io.emtfxml.metadata.ProcessingInfo(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

sign_convention

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: exp(+ iomega t)

Sign convention of the processing software output

exp(+ iomega t)

processed_by

Required: False

Units: None

Type: string

Style: free form

Default: None

Names of people who processed the data

MT Guru

process_date

Required: False

Units: None

Type: string

Style: date

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

Date the data were processed

2020-01-01

processing_tag

Required: False

Units: None

Type: string

Style: free form

Default: None

List of remote references

mt001-mt002

processing_software.name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the software used for processing

EMTF

processing_software.last_mod

Required: False

Units: None

Type: string

Style: date

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

Date the software was last modified

2020-01-01

processing_software.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author of the software used for processing

MT Guru

remote_ref.type

Required: True

Units: None

Type: string

Style: free form

Default: none

type of remote referencing

robust multi- station remote referencing

remote_info.site.project

Required: False

Units: None

Type: string

Style: alpha numeric

Default: None

Name of the project

USMTArray

remote_info.site.survey

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the survey

MT 2020

remote_info.site.year_collected

Required: False

Units: None

Type: integer

Style: number

Default: 1980

Year data collected

2020

remote_info.site.country

Required: False

Units: None

Type: string

Style: free form

Default: None

Country where data was collected

USA

remote_info.site.id

Required: False

Units: None

Type: string

Style: alpha numeric

Default: None

Station ID name. This should be an alpha numeric name that is typically 5-6 characters long. Commonly the project name in 2 or 3 letters and the station number.

MT001

remote_info.site.name

Required: False

Units: None

Type: string

Style: free form

Default: None

closest geographic name to the station

“Whitehorse, YK”

remote_info.site.acquired_by

Required: False

Units: None

Type: string

Style: free form

Default: None

Person or group who collected the data

MT Group

remote_info.site.start

Required: False

Units: None

Type: string

Style: date time

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

Date time when the data collection started

2020-01-01T12:0 0:00

remote_info.site.end

Required: False

Units: None

Type: string

Style: date time

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

Date time when the data collection ended

2020-05-01T12:0 0:00

remote_info.site.run_list

Required: False

Units: None

Type: string

Style: name list

Default: []

list of runs recorded by the station. Should be a summary of all runss recorded

“[ mt001a, mt001b, mt001c ]”

remote_info.site.location.latitude

Required: False

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level

23.134

remote_info.site.location.longitude

Required: False

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level

14.23

remote_info.site.location.elevation

Required: False

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level

123.4

remote_info.site.location.latitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees

0.01

remote_info.site.location.longitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees

0.01

remote_info.site.location.elevation_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation

0.01

remote_info.site.location.datum

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

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

WGS84

remote_info.site.location.x

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.x2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.y

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.y2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

remote_info.site.location.z

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

remote_info.site.location.z2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

remote_info.site.location.x_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction

0.01

remote_info.site.location.y_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction

0.01

remote_info.site.location.z_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction

0.01

remote_info.site.orientation.angle_to_geographic_north

Required: False

Units: degrees

Type: float

Style: number

Default: 0.0

Angle to geographic north of the station orientation

0

remote_info.site.orientation.layout

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: orthogonal

Orientation of channels relative to each other

orthogonal

remote_info.site.data_quality_notes.good_from_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number

0.01

remote_info.site.data_quality_notes.good_to_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number

1000

remote_info.site.data_quality_notes.rating

Required: False

Units: None

Type: integer

Style: number

Default: None

Rating of the data from 0 to 5 where 5 is the best and 0 is unrated

4

remote_info.site.data_quality_notes.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

remote_info.site.data_quality_notes.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

remote_info.site.data_quality_notes.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment

remote_info.site.data_quality_warnings.flag

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality

0

remote_info.site.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

remote_info.site.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

remote_info.site.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
property process_date
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.ProcessingSoftware(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the software used for processing

EMTF

last_mod

Required: False

Units: None

Type: string

Style: date

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

Date the software was last modified

2020-01-01

author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author of the software used for processing

MT Guru
property last_mod
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Provenance(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

create_time

Required: True

Units: None

Type: string

Style: date time

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

date and time the file was created

2020-02-08T12:2 3:40.324600+00: 00

creating_application

Required: True

Units: None

Type: string

Style: free form

Default: mt_metadata

name of the application that created the XML file

EMTF File Conversion Utilities 4.0

creator.name

Required: True

Units: None

Type: string

Style: free form

Default: None

author name

person name

creator.email

Required: True

Units: None

Type: string

Style: email

Default: None

email of the contact person

mt.guru@em.org

creator.org

Required: True

Units: None

Type: string

Style: free form

Default: None

organization name

mt gurus

creator.org_url

Required: False

Units: None

Type: string

Style: url

Default: None

URL of organization

https://www.mt_ gurus.org

submitter.name

Required: True

Units: None

Type: string

Style: free form

Default: None

author name

person name

submitter.email

Required: True

Units: None

Type: string

Style: email

Default: None

email of the contact person

mt.guru@em.org

submitter.org

Required: True

Units: None

Type: string

Style: free form

Default: None

organization name

mt gurus

submitter.org_url

Required: False

Units: None

Type: string

Style: url

Default: None

URL of organization

https://www.mt_ gurus.org
property create_time
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.RemoteInfo(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

site.project

Required: True

Units: None

Type: string

Style: alpha numeric

Default: none

Name of the project

USMTArray

site.survey

Required: True

Units: None

Type: string

Style: free form

Default: none

Name of the survey

MT 2020

site.year_collected

Required: True

Units: None

Type: integer

Style: number

Default: 1980

Year data collected

2020

site.country

Required: True

Units: None

Type: string

Style: free form

Default: none

Country where data was collected

USA

site.id

Required: True

Units: None

Type: string

Style: alpha numeric

Default: none

Station ID name. This should be an alpha numeric name that is typically 5-6 characters long. Commonly the project name in 2 or 3 letters and the station number.

MT001

site.name

Required: True

Units: None

Type: string

Style: free form

Default: none

closest geographic name to the station

“Whitehorse, YK”

site.acquired_by

Required: True

Units: None

Type: string

Style: free form

Default: none

Person or group who collected the data

MT Group

site.start

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection started

2020-01-01T12:0 0:00

site.end

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection ended

2020-05-01T12:0 0:00

site.run_list

Required: True

Units: None

Type: string

Style: name list

Default: []

list of runs recorded by the station. Should be a summary of all runss recorded

“[ mt001a, mt001b, mt001c ]”

site.location.latitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level

23.134

site.location.longitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level

14.23

site.location.elevation

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level

123.4

site.location.latitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees

0.01

site.location.longitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees

0.01

site.location.elevation_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation

0.01

site.location.datum

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

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

WGS84

site.location.x

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

site.location.x2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

site.location.y

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

site.location.y2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

site.location.z

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

site.location.z2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

site.location.x_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction

0.01

site.location.y_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction

0.01

site.location.z_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction

0.01

site.orientation.angle_to_geographic_north

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

Angle to geographic north of the station orientation

0

site.orientation.layout

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: orthogonal

Orientation of channels relative to each other

orthogonal

site.data_quality_notes.good_from_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number

0.01

site.data_quality_notes.good_to_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number

1000

site.data_quality_notes.rating

Required: False

Units: None

Type: integer

Style: number

Default: None

Rating of the data from 0 to 5 where 5 is the best and 0 is unrated

4

site.data_quality_notes.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

site.data_quality_notes.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

site.data_quality_notes.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment

site.data_quality_warnings.flag

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality

0

site.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

site.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

site.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.RemoteRef(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

type

Required: True

Units: None

Type: string

Style: free form

Default: None

type of remote referencing

robust multi- station remote referencing
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Run(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

errors

Required: False

Units: None

Type: string

Style: free form

Default: None

Any field errors

moose ate cables

run

Required: True

Units: None

Type: string

Style: free form

Default: None

Run name

mt001a

sampling_rate

Required: False

Units: samples per second

Type: float

Style: number

Default: None

Sample rate of the run

1

start

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection started

2020-01-01T12:0 0:00

end

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection ended

2020-05-01T12:0 0:00

instrument.id

Required: True

Units: None

Type: string

Style: free form

Default: none

instrument ID number can be serial number or a designated ID

mt01

instrument.manufacturer

Required: True

Units: None

Type: string

Style: free form

Default: none

who manufactured the instrument

mt gurus

instrument.type

Required: True

Units: None

Type: string

Style: free form

Default: none

instrument type

broadband 32-bit

instrument.model

Required: False

Units: None

Type: string

Style: free form

Default: None

model version of the instrument

falcon5

instrument.name

Required: False

Units: None

Type: string

Style: free form

Default: None

Name of the model of the instrument

falcon5

instrument.settings

Required: False

Units: None

Type: string

Style: free form

Default: None

Any settings for the instrument

notch filter applied

comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
property end
read_dict(input_dict)[source]

Field notes are odd so have a special reader to do it piece by painstaking piece.

Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property start
to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to True

  • required (TYPE, optional) – DESCRIPTION, defaults to False

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.Site(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

project

Required: True

Units: None

Type: string

Style: alpha numeric

Default: None

Name of the project

USMTArray

survey

Required: True

Units: None

Type: string

Style: free form

Default: None

Name of the survey

MT 2020

year_collected

Required: True

Units: None

Type: integer

Style: number

Default: 1980

Year data collected

2020

country

Required: True

Units: None

Type: string

Style: free form

Default: None

Country where data was collected

USA

id

Required: True

Units: None

Type: string

Style: alpha numeric

Default: None

Station ID name. This should be an alpha numeric name that is typically 5-6 characters long. Commonly the project name in 2 or 3 letters and the station number.

MT001

name

Required: True

Units: None

Type: string

Style: free form

Default: None

closest geographic name to the station

“Whitehorse, YK”

acquired_by

Required: True

Units: None

Type: string

Style: free form

Default: None

Person or group who collected the data

MT Group

start

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection started

2020-01-01T12:0 0:00

end

Required: True

Units: None

Type: string

Style: date time

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

Date time when the data collection ended

2020-05-01T12:0 0:00

run_list

Required: True

Units: None

Type: string

Style: name list

Default: []

list of runs recorded by the station. Should be a summary of all runss recorded

“[ mt001a, mt001b, mt001c ]”

location.latitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

latitude of location in datum specified at survey level

23.134

location.longitude

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

longitude of location in datum specified at survey level

14.23

location.elevation

Required: True

Units: meters

Type: float

Style: number

Default: 0.0

elevation of location in datum specified at survey level

123.4

location.latitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in latitude estimation in degrees

0.01

location.longitude_uncertainty

Required: False

Units: degrees

Type: float

Style: number

Default: None

uncertainty in longitude estimation in degrees

0.01

location.elevation_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in elevation estimation

0.01

location.datum

Required: False

Units: None

Type: string

Style: controlled vocabulary

Default: None

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

WGS84

location.x

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.x2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.y

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.y2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative distance to the center of the station

10.0

location.z

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

location.z2

Required: False

Units: meters

Type: float

Style: number

Default: None

relative elevation to the center of the station

10.0

location.x_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in x-direction

0.01

location.y_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in y-direction

0.01

location.z_uncertainty

Required: False

Units: meters

Type: float

Style: number

Default: None

uncertainty in longitude estimation in z-direction

0.01

orientation.angle_to_geographic_north

Required: True

Units: degrees

Type: float

Style: number

Default: 0.0

Angle to geographic north of the station orientation

0

orientation.layout

Required: True

Units: None

Type: string

Style: controlled vocabulary

Default: orthogonal

Orientation of channels relative to each other

orthogonal

data_quality_notes.good_from_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods larger than this number

0.01

data_quality_notes.good_to_period

Required: False

Units: None

Type: float

Style: number

Default: None

Data are good for periods smaller than this number

1000

data_quality_notes.rating

Required: False

Units: None

Type: integer

Style: number

Default: None

Rating of the data from 0 to 5 where 5 is the best and 0 is unrated

4

data_quality_notes.comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

data_quality_notes.comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

data_quality_notes.comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment

data_quality_warnings.flag

Required: False

Units: None

Type: integer

Style: number

Default: None

Flag for data quality

0

comments.author

Required: False

Units: None

Type: string

Style: free form

Default: None

Author who made the comment

  1. Tee

comments.date

Required: False

Units: None

Type: string

Style: date

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

Date the comment was made

2020-01-21

comments.value

Required: False

Units: None

Type: string

Style: free form

Default: None

Comment string

This is a comment
property end
read_dict(input_dict)[source]
Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property run_list
property start
to_xml(string=False, required=True)[source]
property year_collected
class mt_metadata.transfer_functions.io.emtfxml.metadata.SiteLayout(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

input_channels

Required: True

Units: None

Type: string

Style: name list

Default: []

list of input channels for transfer function estimation

[Magnetic(hx), Magnetic(hy)]

output_channels

Required: True

Units: None

Type: string

Style: name list

Default: []

list of output channels for transfer function estimation

[Electric(ex), Electric(ey), Magnetic(hz)]
property input_channel_names
property input_channels
property output_channel_names
property output_channels
read_dict(input_dict)[source]

read site layout into the proper input/output channels

Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.StatisticalEstimates(**kwargs)[source]

Bases: Base

Metadata Key

Description

Example

estimates_list

Required: True

Units: None

Type: string

Style: name list

Default: []

list of statistical estimates

[var cov]
property estimates_list
read_dict(input_dict)[source]

Read in statistical estimate descriptions

Parameters:

input_dict (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

to_xml(string=False, required=True)[source]
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE

class mt_metadata.transfer_functions.io.emtfxml.metadata.TransferFunction[source]

Bases: Base

Deal with the complex XML format

property array_dict
initialize_arrays(n_periods)[source]
property n_periods
property period

periods for estimates

read_block(block, period_index)[source]

Read a period block which is root_dict[“data”][“period”][ii]

Parameters:

block (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

read_dict(root_dict)[source]

read root_dict[“data”] :param root_dict: DESCRIPTION :type root_dict: TYPE :return: DESCRIPTION :rtype: TYPE

property t

ts for estimates

property t_invsigcov

t_invsigcov for estimates

property t_residcov

t_residcov for estimates

property t_var

t_var for estimates

to_xml(string=False, required=True)[source]

Write data blocks

Parameters:

parent (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

write_block(parent, index)[source]

Write a data block

Parameters:

parent (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property z

zs for estimates

property z_invsigcov

z_invsigcov for estimates

property z_residcov

z_residcov for estimates

property z_var

z_var for estimates