mt_metadata.transfer_functions.io.emtfxml package

Subpackages

• mt_metadata.transfer_functions.io.emtfxml.metadata package
  • Subpackages
    • mt_metadata.transfer_functions.io.emtfxml.metadata.standards package
      • Module contents
  • Submodules
  • mt_metadata.transfer_functions.io.emtfxml.metadata.attachment module
    • Attachment
      • Attachment.read_dict()
      • Attachment.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.channels module
    • Channels
  • mt_metadata.transfer_functions.io.emtfxml.metadata.citation module
    • Citation
      • Citation.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.comment module
    • Comment
      • Comment.date
      • Comment.read_dict()
      • Comment.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.copyright module
    • Copyright
      • Copyright.read_dict()
      • Copyright.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.data module
    • TransferFunction
      • TransferFunction.array_dict
      • TransferFunction.initialize_arrays()
      • TransferFunction.n_periods
      • TransferFunction.period
      • TransferFunction.read_block()
      • TransferFunction.read_dict()
      • TransferFunction.t
      • TransferFunction.t_invsigcov
      • TransferFunction.t_residcov
      • TransferFunction.t_var
      • TransferFunction.to_xml()
      • TransferFunction.write_block()
      • TransferFunction.z
      • TransferFunction.z_invsigcov
      • TransferFunction.z_residcov
      • TransferFunction.z_var
  • mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_notes module
    • DataQualityNotes
      • DataQualityNotes.read_dict()
      • DataQualityNotes.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_warnings module
    • DataQualityWarnings
      • DataQualityWarnings.read_dict()
      • DataQualityWarnings.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.data_type module
    • DataType
      • DataType.read_dict()
      • DataType.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.data_types module
    • DataTypes
      • DataTypes.data_types_list
      • DataTypes.read_dict()
      • DataTypes.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.dipole module
    • Dipole
      • Dipole.electrode
      • Dipole.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.electric module
    • Electric
      • Electric.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.electrode module
    • Electrode
      • Electrode.comments
      • Electrode.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.emtf module
    • EMTF
  • mt_metadata.transfer_functions.io.emtfxml.metadata.estimate module
    • Estimate
      • Estimate.read_dict()
      • Estimate.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.external_url module
    • ExternalUrl
      • ExternalUrl.read_dict()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.field_notes module
    • FieldNotes
      • FieldNotes.read_dict()
      • FieldNotes.run_list
      • FieldNotes.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.magnetic module
    • Magnetic
      • Magnetic.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.magnetometer module
    • Magnetometer
      • Magnetometer.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.period_range module
    • PeriodRange
      • PeriodRange.read_dict()
      • PeriodRange.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.person module
    • Person
  • mt_metadata.transfer_functions.io.emtfxml.metadata.primary_data module
    • PrimaryData
      • PrimaryData.read_dict()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.processing_info module
    • ProcessingInfo
      • ProcessingInfo.process_date
      • ProcessingInfo.read_dict()
      • ProcessingInfo.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.provenance module
    • Provenance
      • Provenance.create_time
      • Provenance.read_dict()
      • Provenance.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.remote_ref module
    • RemoteRef
      • RemoteRef.read_dict()
      • RemoteRef.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.site module
    • Site
      • Site.end
      • Site.read_dict()
      • Site.run_list
      • Site.start
      • Site.to_xml()
      • Site.year_collected
  • mt_metadata.transfer_functions.io.emtfxml.metadata.site_layout module
    • SiteLayout
      • SiteLayout.input_channel_names
      • SiteLayout.input_channels
      • SiteLayout.output_channel_names
      • SiteLayout.output_channels
      • SiteLayout.read_dict()
      • SiteLayout.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.software module
    • ProcessingSoftware
      • ProcessingSoftware.last_mod
      • ProcessingSoftware.read_dict()
      • ProcessingSoftware.to_xml()
  • mt_metadata.transfer_functions.io.emtfxml.metadata.statistical_estimates module
    • StatisticalEstimates
      • StatisticalEstimates.estimates_list
      • StatisticalEstimates.read_dict()
      • StatisticalEstimates.to_xml()
  • Module contents
    • EMTF XML metadata
    • Attachment
      • Attachment.read_dict()
      • Attachment.to_xml()
    • Channels
    • Citation
      • Citation.to_xml()
    • Comment
      • Comment.date
      • Comment.read_dict()
      • Comment.to_xml()
    • Copyright
      • Copyright.read_dict()
      • Copyright.to_xml()
    • DataQualityNotes
      • DataQualityNotes.read_dict()
      • DataQualityNotes.to_xml()
    • DataQualityWarnings
      • DataQualityWarnings.read_dict()
      • DataQualityWarnings.to_xml()
    • DataType
      • DataType.read_dict()
      • DataType.to_xml()
    • DataTypes
      • DataTypes.data_types_list
      • DataTypes.read_dict()
      • DataTypes.to_xml()
    • Dipole
      • Dipole.electrode
      • Dipole.to_xml()
    • EMTF
    • Electric
      • Electric.to_xml()
    • Electrode
      • Electrode.comments
      • Electrode.to_xml()
    • Estimate
      • Estimate.read_dict()
      • Estimate.to_xml()
    • ExternalUrl
      • ExternalUrl.read_dict()
    • FieldNotes
      • FieldNotes.read_dict()
      • FieldNotes.run_list
      • FieldNotes.to_xml()
    • Instrument
      • Instrument.to_xml()
    • Location
      • Location.elevation
      • Location.latitude
      • Location.longitude
      • Location.read_dict()
      • Location.to_xml()
    • Magnetic
      • Magnetic.to_xml()
    • Magnetometer
      • Magnetometer.to_xml()
    • Orientation
      • Orientation.read_dict()
      • Orientation.to_xml()
    • PeriodRange
      • PeriodRange.read_dict()
      • PeriodRange.to_xml()
    • Person
    • PrimaryData
      • PrimaryData.read_dict()
    • ProcessingInfo
      • ProcessingInfo.process_date
      • ProcessingInfo.read_dict()
      • ProcessingInfo.to_xml()
    • ProcessingSoftware
      • ProcessingSoftware.last_mod
      • ProcessingSoftware.read_dict()
      • ProcessingSoftware.to_xml()
    • Provenance
      • Provenance.create_time
      • Provenance.read_dict()
      • Provenance.to_xml()
    • RemoteInfo
      • RemoteInfo.read_dict()
      • RemoteInfo.to_xml()
    • RemoteRef
      • RemoteRef.read_dict()
      • RemoteRef.to_xml()
    • Run
      • Run.end
      • Run.read_dict()
      • Run.start
      • Run.to_xml()
    • Site
      • Site.end
      • Site.read_dict()
      • Site.run_list
      • Site.start
      • Site.to_xml()
      • Site.year_collected
    • SiteLayout
      • SiteLayout.input_channel_names
      • SiteLayout.input_channels
      • SiteLayout.output_channel_names
      • SiteLayout.output_channels
      • SiteLayout.read_dict()
      • SiteLayout.to_xml()
    • StatisticalEstimates
      • StatisticalEstimates.estimates_list
      • StatisticalEstimates.read_dict()
      • StatisticalEstimates.to_xml()
    • TransferFunction
      • TransferFunction.array_dict
      • TransferFunction.initialize_arrays()
      • TransferFunction.n_periods
      • TransferFunction.period
      • TransferFunction.read_block()
      • TransferFunction.read_dict()
      • TransferFunction.t
      • TransferFunction.t_invsigcov
      • TransferFunction.t_residcov
      • TransferFunction.t_var
      • TransferFunction.to_xml()
      • TransferFunction.write_block()
      • TransferFunction.z
      • TransferFunction.z_invsigcov
      • TransferFunction.z_residcov
      • TransferFunction.z_var

Submodules

mt_metadata.transfer_functions.io.emtfxml.emtfxml module

EMTFXML

This is meant to follow Anna’s XML schema for transfer functions

Created on Sat Sep 4 17:59:53 2021

@author: jpeacock

class mt_metadata.transfer_functions.io.emtfxml.emtfxml.EMTFXML(fn=None, **kwargs)

Bases: EMTF

This is meant to follow Anna’s XML schema for transfer functions

property fn

read(fn=None, get_elevation=False)

Read xml file

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property save_dir

property station_metadata

property survey_metadata

write(fn, skip_field_notes=False)

Write an xml :param fn: DESCRIPTION :type fn: TYPE :return: DESCRIPTION :rtype: TYPE

Module contents

class mt_metadata.transfer_functions.io.emtfxml.EMTFXML(fn=None, **kwargs)

Bases: EMTF

This is meant to follow Anna’s XML schema for transfer functions

property fn

read(fn=None, get_elevation=False)

Read xml file

Parameters:

fn (TYPE) – DESCRIPTION

Returns:

DESCRIPTION

Return type:

TYPE

property save_dir

property station_metadata

property survey_metadata

write(fn, skip_field_notes=False)

Write an xml :param fn: DESCRIPTION :type fn: TYPE :return: DESCRIPTION :rtype: TYPE