mt_metadata package
Subpackages
- mt_metadata.base package
- Submodules
- mt_metadata.base.helpers module
NumpyEncoderdict_to_xml()element_to_dict()element_to_string()flatten_dict()flatten_list()get_type()get_units()recursive_split_dict()recursive_split_getattr()recursive_split_setattr()recursive_split_xml()structure_dict()validate_c1()validate_name()wrap_description()write_block()write_lines()
- mt_metadata.base.metadata module
BaseBase.add_base_attribute()Base.attribute_information()Base.changedBase.copy()Base.from_dict()Base.from_json()Base.from_series()Base.from_xml()Base.get_attr_from_name()Base.get_attribute_list()Base.set_attr_from_name()Base.to_dict()Base.to_json()Base.to_series()Base.to_xml()Base.update()
- mt_metadata.base.schema module
- Module contents
BaseBase.add_base_attribute()Base.attribute_information()Base.changedBase.copy()Base.from_dict()Base.from_json()Base.from_series()Base.from_xml()Base.get_attr_from_name()Base.get_attribute_list()Base.set_attr_from_name()Base.to_dict()Base.to_json()Base.to_series()Base.to_xml()Base.update()
BaseDictget_schema()
- mt_metadata.data package
- mt_metadata.timeseries package
- Subpackages
- mt_metadata.timeseries.filters package
- Subpackages
- Submodules
- mt_metadata.timeseries.filters.channel_response_filter module
- mt_metadata.timeseries.filters.coefficient_filter module
- mt_metadata.timeseries.filters.filter_base module
FilterBaseFilterBase.calibration_dateFilterBase.complex_response()FilterBase.decimation_activeFilterBase.from_obspy_stage()FilterBase.generate_frequency_axis()FilterBase.get_filter_description()FilterBase.make_obspy_mapping()FilterBase.nameFilterBase.obspy_mappingFilterBase.pass_band()FilterBase.plot_response()FilterBase.total_gainFilterBase.units_inFilterBase.units_out
get_base_obspy_mapping()
- mt_metadata.timeseries.filters.filtered module
- mt_metadata.timeseries.filters.fir_filter module
FIRFilterFIRFilter.coefficient_gainFIRFilter.coefficientsFIRFilter.complex_response()FIRFilter.corrective_scalarFIRFilter.make_obspy_mapping()FIRFilter.n_coefficientsFIRFilter.output_sampling_rateFIRFilter.plot_fir_response()FIRFilter.symmetry_corrected_coefficientsFIRFilter.to_obspy()FIRFilter.unscaled_complex_response()
- mt_metadata.timeseries.filters.frequency_response_table_filter module
FrequencyResponseTableFilterFrequencyResponseTableFilter.amplitudesFrequencyResponseTableFilter.complex_response()FrequencyResponseTableFilter.frequenciesFrequencyResponseTableFilter.make_obspy_mapping()FrequencyResponseTableFilter.max_frequencyFrequencyResponseTableFilter.min_frequencyFrequencyResponseTableFilter.phasesFrequencyResponseTableFilter.to_obspy()
- mt_metadata.timeseries.filters.helper_functions module
- mt_metadata.timeseries.filters.obspy_stages module
- mt_metadata.timeseries.filters.plotting_helpers module
- mt_metadata.timeseries.filters.pole_zero_filter module
- mt_metadata.timeseries.filters.time_delay_filter module
- Module contents
ChannelResponseChannelResponse.complex_response()ChannelResponse.compute_instrument_sensitivity()ChannelResponse.delay_filtersChannelResponse.filters_listChannelResponse.frequenciesChannelResponse.get_indices_of_filters_to_remove()ChannelResponse.get_list_of_filters_to_remove()ChannelResponse.namesChannelResponse.non_delay_filtersChannelResponse.normalization_frequencyChannelResponse.pass_bandChannelResponse.plot_response()ChannelResponse.to_obspy()ChannelResponse.total_delayChannelResponse.units_inChannelResponse.units_out
CoefficientFilterFIRFilterFIRFilter.coefficient_gainFIRFilter.coefficientsFIRFilter.complex_response()FIRFilter.corrective_scalarFIRFilter.make_obspy_mapping()FIRFilter.n_coefficientsFIRFilter.output_sampling_rateFIRFilter.plot_fir_response()FIRFilter.symmetry_corrected_coefficientsFIRFilter.to_obspy()FIRFilter.unscaled_complex_response()
FrequencyResponseTableFilterFrequencyResponseTableFilter.amplitudesFrequencyResponseTableFilter.complex_response()FrequencyResponseTableFilter.frequenciesFrequencyResponseTableFilter.make_obspy_mapping()FrequencyResponseTableFilter.max_frequencyFrequencyResponseTableFilter.min_frequencyFrequencyResponseTableFilter.phasesFrequencyResponseTableFilter.to_obspy()
PoleZeroFilterTimeDelayFilter
- mt_metadata.timeseries.standards package
- mt_metadata.timeseries.stationxml package
- Submodules
- mt_metadata.timeseries.stationxml.fdsn_tools module
- mt_metadata.timeseries.stationxml.utils module
- mt_metadata.timeseries.stationxml.xml_channel_mt_channel module
- mt_metadata.timeseries.stationxml.xml_equipment_mt_run module
- mt_metadata.timeseries.stationxml.xml_inventory_mt_experiment module
- mt_metadata.timeseries.stationxml.xml_network_mt_survey module
- mt_metadata.timeseries.stationxml.xml_station_mt_station module
- Module contents
- mt_metadata.timeseries.tools package
- Submodules
- mt_metadata.timeseries.tools.from_many_mt_files module
MT2StationXMLMT2StationXML.filtersMT2StationXML.get_mt_channel()MT2StationXML.get_xml_files()MT2StationXML.has_xml_path()MT2StationXML.is_a_channel_xml()MT2StationXML.is_a_filter_xml()MT2StationXML.is_a_run_xml()MT2StationXML.is_a_station_xml()MT2StationXML.is_a_survey_xml()MT2StationXML.make_df()MT2StationXML.make_experiment()MT2StationXML.read_xml_file()MT2StationXML.sort_by_station()MT2StationXML.stationsMT2StationXML.surveyMT2StationXML.xml_path
- Module contents
MT2StationXMLMT2StationXML.filtersMT2StationXML.get_mt_channel()MT2StationXML.get_xml_files()MT2StationXML.has_xml_path()MT2StationXML.is_a_channel_xml()MT2StationXML.is_a_filter_xml()MT2StationXML.is_a_run_xml()MT2StationXML.is_a_station_xml()MT2StationXML.is_a_survey_xml()MT2StationXML.make_df()MT2StationXML.make_experiment()MT2StationXML.read_xml_file()MT2StationXML.sort_by_station()MT2StationXML.stationsMT2StationXML.surveyMT2StationXML.xml_path
- mt_metadata.timeseries.filters package
- Submodules
- mt_metadata.timeseries.auxiliary module
- mt_metadata.timeseries.battery module
- mt_metadata.timeseries.channel module
- mt_metadata.timeseries.citation module
- mt_metadata.timeseries.copyright module
- mt_metadata.timeseries.data_logger module
- mt_metadata.timeseries.data_quality module
- mt_metadata.timeseries.declination module
- mt_metadata.timeseries.diagnostic module
- mt_metadata.timeseries.electric module
- mt_metadata.timeseries.electrode module
- mt_metadata.timeseries.experiment module
ExperimentExperiment.add_survey()Experiment.from_dict()Experiment.from_json()Experiment.from_pickle()Experiment.from_xml()Experiment.get_survey()Experiment.has_survey()Experiment.sort()Experiment.survey_index()Experiment.survey_namesExperiment.surveysExperiment.to_dict()Experiment.to_json()Experiment.to_pickle()Experiment.to_xml()Experiment.validate_experiment()
- mt_metadata.timeseries.fdsn module
- mt_metadata.timeseries.instrument module
- mt_metadata.timeseries.location module
- mt_metadata.timeseries.magnetic module
- mt_metadata.timeseries.orientation module
- mt_metadata.timeseries.person module
- mt_metadata.timeseries.provenance module
- mt_metadata.timeseries.rating module
- mt_metadata.timeseries.run module
RunRun.add_channel()Run.channel_index()Run.channelsRun.channels_recorded_allRun.channels_recorded_auxiliaryRun.channels_recorded_electricRun.channels_recorded_magneticRun.exRun.eyRun.get_channel()Run.has_channel()Run.hxRun.hyRun.hzRun.n_channelsRun.remove_channel()Run.temperatureRun.update()Run.update_time_period()
- mt_metadata.timeseries.software module
- mt_metadata.timeseries.station module
- mt_metadata.timeseries.survey module
- mt_metadata.timeseries.time_period module
- mt_metadata.timeseries.timing_system module
- Module contents
- time series metadata
AuxiliaryBatteryChannelCitationCopyrightDataLoggerDataQualityDeclinationDiagnosticElectricElectrodeExperimentExperiment.add_survey()Experiment.from_dict()Experiment.from_json()Experiment.from_pickle()Experiment.from_xml()Experiment.get_survey()Experiment.has_survey()Experiment.sort()Experiment.survey_index()Experiment.survey_namesExperiment.surveysExperiment.to_dict()Experiment.to_json()Experiment.to_pickle()Experiment.to_xml()Experiment.validate_experiment()
FdsnFilterBaseFilterBase.calibration_dateFilterBase.complex_response()FilterBase.decimation_activeFilterBase.from_obspy_stage()FilterBase.generate_frequency_axis()FilterBase.get_filter_description()FilterBase.make_obspy_mapping()FilterBase.nameFilterBase.obspy_mappingFilterBase.pass_band()FilterBase.plot_response()FilterBase.total_gainFilterBase.units_inFilterBase.units_out
FilteredFundingSourceGeographicLocationInstrumentLocationMagneticOrientationPersonProvenanceRatingRunRun.add_channel()Run.channel_index()Run.channelsRun.channels_recorded_allRun.channels_recorded_auxiliaryRun.channels_recorded_electricRun.channels_recorded_magneticRun.exRun.eyRun.get_channel()Run.has_channel()Run.hxRun.hyRun.hzRun.n_channelsRun.remove_channel()Run.temperatureRun.update()Run.update_time_period()
SoftwareStationSurveyTimePeriodTimingSystem
- Subpackages
- mt_metadata.transfer_functions package
- Subpackages
- mt_metadata.transfer_functions.io package
- Subpackages
- mt_metadata.transfer_functions.io.edi package
- Subpackages
- mt_metadata.transfer_functions.io.edi.metadata package
- Subpackages
- Submodules
- mt_metadata.transfer_functions.io.edi.metadata.data_section module
- mt_metadata.transfer_functions.io.edi.metadata.define_measurement module
DefineMeasurementDefineMeasurement.channel_idsDefineMeasurement.channels_recordedDefineMeasurement.from_metadata()DefineMeasurement.get_measurement_dict()DefineMeasurement.get_measurement_lists()DefineMeasurement.read_measurement()DefineMeasurement.refelevDefineMeasurement.reflatDefineMeasurement.reflonDefineMeasurement.reflongDefineMeasurement.write_measurement()
- mt_metadata.transfer_functions.io.edi.metadata.emeasurement module
- mt_metadata.transfer_functions.io.edi.metadata.header module
- mt_metadata.transfer_functions.io.edi.metadata.hmeasurement module
- mt_metadata.transfer_functions.io.edi.metadata.information module
- Module contents
DataSectionDefineMeasurementDefineMeasurement.channel_idsDefineMeasurement.channels_recordedDefineMeasurement.from_metadata()DefineMeasurement.get_measurement_dict()DefineMeasurement.get_measurement_lists()DefineMeasurement.read_measurement()DefineMeasurement.refelevDefineMeasurement.reflatDefineMeasurement.reflonDefineMeasurement.reflongDefineMeasurement.write_measurement()
EMeasurementHMeasurementHeaderInformation
- mt_metadata.transfer_functions.io.edi.metadata package
- Submodules
- mt_metadata.transfer_functions.io.edi.edi module
- Module contents
- Subpackages
- mt_metadata.transfer_functions.io.emtfxml package
- Subpackages
- mt_metadata.transfer_functions.io.emtfxml.metadata package
- Subpackages
- Submodules
- mt_metadata.transfer_functions.io.emtfxml.metadata.attachment module
- mt_metadata.transfer_functions.io.emtfxml.metadata.channels module
- mt_metadata.transfer_functions.io.emtfxml.metadata.citation module
- mt_metadata.transfer_functions.io.emtfxml.metadata.comment module
- mt_metadata.transfer_functions.io.emtfxml.metadata.copyright module
- mt_metadata.transfer_functions.io.emtfxml.metadata.data module
TransferFunctionTransferFunction.array_dictTransferFunction.initialize_arrays()TransferFunction.n_periodsTransferFunction.periodTransferFunction.read_block()TransferFunction.read_dict()TransferFunction.tTransferFunction.t_invsigcovTransferFunction.t_residcovTransferFunction.t_varTransferFunction.to_xml()TransferFunction.write_block()TransferFunction.zTransferFunction.z_invsigcovTransferFunction.z_residcovTransferFunction.z_var
- mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_notes module
- mt_metadata.transfer_functions.io.emtfxml.metadata.data_quality_warnings module
- mt_metadata.transfer_functions.io.emtfxml.metadata.data_type module
- mt_metadata.transfer_functions.io.emtfxml.metadata.data_types module
- mt_metadata.transfer_functions.io.emtfxml.metadata.dipole module
- mt_metadata.transfer_functions.io.emtfxml.metadata.electric module
- mt_metadata.transfer_functions.io.emtfxml.metadata.electrode module
- mt_metadata.transfer_functions.io.emtfxml.metadata.emtf module
- mt_metadata.transfer_functions.io.emtfxml.metadata.estimate module
- mt_metadata.transfer_functions.io.emtfxml.metadata.external_url module
- mt_metadata.transfer_functions.io.emtfxml.metadata.field_notes module
- mt_metadata.transfer_functions.io.emtfxml.metadata.magnetic module
- mt_metadata.transfer_functions.io.emtfxml.metadata.magnetometer module
- mt_metadata.transfer_functions.io.emtfxml.metadata.period_range module
- mt_metadata.transfer_functions.io.emtfxml.metadata.person module
- mt_metadata.transfer_functions.io.emtfxml.metadata.primary_data module
- mt_metadata.transfer_functions.io.emtfxml.metadata.processing_info module
- mt_metadata.transfer_functions.io.emtfxml.metadata.provenance module
- mt_metadata.transfer_functions.io.emtfxml.metadata.remote_ref module
- mt_metadata.transfer_functions.io.emtfxml.metadata.site module
- mt_metadata.transfer_functions.io.emtfxml.metadata.site_layout module
- mt_metadata.transfer_functions.io.emtfxml.metadata.software module
- mt_metadata.transfer_functions.io.emtfxml.metadata.statistical_estimates module
- Module contents
- EMTF XML metadata
AttachmentChannelsCitationCommentCopyrightDataQualityNotesDataQualityWarningsDataTypeDataTypesDipoleEMTFElectricElectrodeEstimateExternalUrlFieldNotesInstrumentLocationMagneticMagnetometerOrientationPeriodRangePersonPrimaryDataProcessingInfoProcessingSoftwareProvenanceRemoteInfoRemoteRefRunSiteSiteLayoutStatisticalEstimatesTransferFunctionTransferFunction.array_dictTransferFunction.initialize_arrays()TransferFunction.n_periodsTransferFunction.periodTransferFunction.read_block()TransferFunction.read_dict()TransferFunction.tTransferFunction.t_invsigcovTransferFunction.t_residcovTransferFunction.t_varTransferFunction.to_xml()TransferFunction.write_block()TransferFunction.zTransferFunction.z_invsigcovTransferFunction.z_residcovTransferFunction.z_var
- mt_metadata.transfer_functions.io.emtfxml.metadata package
- Submodules
- mt_metadata.transfer_functions.io.emtfxml.emtfxml module
- Module contents
- Subpackages
- mt_metadata.transfer_functions.io.jfiles package
- Subpackages
- mt_metadata.transfer_functions.io.jfiles.metadata package
- Subpackages
- Submodules
- mt_metadata.transfer_functions.io.jfiles.metadata.birrp_angles module
- mt_metadata.transfer_functions.io.jfiles.metadata.birrp_block module
- mt_metadata.transfer_functions.io.jfiles.metadata.birrp_parameters module
- mt_metadata.transfer_functions.io.jfiles.metadata.header module
- Module contents
- mt_metadata.transfer_functions.io.jfiles.metadata package
- Submodules
- mt_metadata.transfer_functions.io.jfiles.jfile module
- Module contents
- Subpackages
- mt_metadata.transfer_functions.io.zfiles package
- Subpackages
- Submodules
- mt_metadata.transfer_functions.io.zfiles.zmm module
ZMMZMMErrorZMMHeaderZMMHeader.channel_dictZMMHeader.channels_recordedZMMHeader.declinationZMMHeader.elevationZMMHeader.fnZMMHeader.has_impedanceZMMHeader.has_tipperZMMHeader.input_channelsZMMHeader.latitudeZMMHeader.longitudeZMMHeader.output_channelsZMMHeader.read_header()ZMMHeader.stationZMMHeader.write_header()
- Module contents
- mt_metadata.transfer_functions.io.zonge package
- Subpackages
- mt_metadata.transfer_functions.io.zonge.metadata package
- Subpackages
- Submodules
- mt_metadata.transfer_functions.io.zonge.metadata.auto module
- mt_metadata.transfer_functions.io.zonge.metadata.d_plus module
- mt_metadata.transfer_functions.io.zonge.metadata.gps module
- mt_metadata.transfer_functions.io.zonge.metadata.header module
- mt_metadata.transfer_functions.io.zonge.metadata.mt_edit module
- mt_metadata.transfer_functions.io.zonge.metadata.phase_slope module
- mt_metadata.transfer_functions.io.zonge.metadata.rx module
- mt_metadata.transfer_functions.io.zonge.metadata.survey module
- mt_metadata.transfer_functions.io.zonge.metadata.tx module
- mt_metadata.transfer_functions.io.zonge.metadata.unit module
- Module contents
- mt_metadata.transfer_functions.io.zonge.metadata package
- Submodules
- mt_metadata.transfer_functions.io.zonge.zonge module
- Module contents
- Subpackages
- mt_metadata.transfer_functions.io.edi package
- Submodules
- mt_metadata.transfer_functions.io.tools module
- Module contents
- Subpackages
- mt_metadata.transfer_functions.tf package
- Subpackages
- Submodules
- mt_metadata.transfer_functions.tf.comment module
- mt_metadata.transfer_functions.tf.station module
- mt_metadata.transfer_functions.tf.statistical_estimate module
- mt_metadata.transfer_functions.tf.transfer_function module
- Module contents
- metadata
AuxiliaryBatteryChannelCitationCommentCopyrightDataLoggerDataQualityDeclinationDiagnosticElectricElectrodeFdsnFilterBaseFilterBase.calibration_dateFilterBase.complex_response()FilterBase.decimation_activeFilterBase.from_obspy_stage()FilterBase.generate_frequency_axis()FilterBase.get_filter_description()FilterBase.make_obspy_mapping()FilterBase.nameFilterBase.obspy_mappingFilterBase.pass_band()FilterBase.plot_response()FilterBase.total_gainFilterBase.units_inFilterBase.units_out
FilteredInstrumentLocationMagneticOrientationPersonProvenanceRatingRunRun.add_channel()Run.channel_index()Run.channelsRun.channels_recorded_allRun.channels_recorded_auxiliaryRun.channels_recorded_electricRun.channels_recorded_magneticRun.exRun.eyRun.get_channel()Run.has_channel()Run.hxRun.hyRun.hzRun.n_channelsRun.remove_channel()Run.temperatureRun.update()Run.update_time_period()
SoftwareStationStatisticalEstimateSurveyTimePeriodTimingSystemTransferFunction
- mt_metadata.transfer_functions.io package
- Submodules
- mt_metadata.transfer_functions.core module
TFTF.channel_nomenclatureTF.copy()TF.datasetTF.elevationTF.fnTF.frequencyTF.from_avg()TF.from_edi()TF.from_emtfxml()TF.from_jfile()TF.from_ts_station_metadata()TF.from_zmm()TF.from_zrr()TF.from_zss()TF.has_impedance()TF.has_inverse_signal_power()TF.has_residual_covariance()TF.has_tipper()TF.has_transfer_function()TF.impedanceTF.impedance_errorTF.impedance_model_errorTF.index_tzxTF.index_tzyTF.index_zxxTF.index_zxyTF.index_zyxTF.index_zyyTF.inverse_channel_nomenclatureTF.inverse_signal_powerTF.latitudeTF.longitudeTF.make_zmm_run()TF.merge()TF.periodTF.read()TF.read_tf_file()TF.residual_covarianceTF.run_metadataTF.stationTF.station_metadataTF.surveyTF.survey_metadataTF.tf_idTF.tipperTF.tipper_errorTF.tipper_model_errorTF.to_avg()TF.to_edi()TF.to_emtfxml()TF.to_jfile()TF.to_ts_station_metadata()TF.to_zmm()TF.to_zrr()TF.to_zss()TF.transfer_functionTF.transfer_function_errorTF.transfer_function_model_errorTF.write()TF.write_tf_file()
TFError
- Module contents
TFTF.channel_nomenclatureTF.copy()TF.datasetTF.elevationTF.fnTF.frequencyTF.from_avg()TF.from_edi()TF.from_emtfxml()TF.from_jfile()TF.from_ts_station_metadata()TF.from_zmm()TF.from_zrr()TF.from_zss()TF.has_impedance()TF.has_inverse_signal_power()TF.has_residual_covariance()TF.has_tipper()TF.has_transfer_function()TF.impedanceTF.impedance_errorTF.impedance_model_errorTF.index_tzxTF.index_tzyTF.index_zxxTF.index_zxyTF.index_zyxTF.index_zyyTF.inverse_channel_nomenclatureTF.inverse_signal_powerTF.latitudeTF.longitudeTF.make_zmm_run()TF.merge()TF.periodTF.read()TF.read_tf_file()TF.residual_covarianceTF.run_metadataTF.stationTF.station_metadataTF.surveyTF.survey_metadataTF.tf_idTF.tipperTF.tipper_errorTF.tipper_model_errorTF.to_avg()TF.to_edi()TF.to_emtfxml()TF.to_jfile()TF.to_ts_station_metadata()TF.to_zmm()TF.to_zrr()TF.to_zss()TF.transfer_functionTF.transfer_function_errorTF.transfer_function_model_errorTF.write()TF.write_tf_file()
- Subpackages
- mt_metadata.utils package
Module contents
metadata
This module deals with metadata as defined by the MT metadata standards.
There are multiple containers for each type of metadata, named appropriately.
- Each container will be able to read and write:
dictionary
json
xml
csv?
pandas.Series
anything else?
Each container has an attribute called _attr_dict which dictates if the attribute is included in output objects, the data type, whether it is a required parameter, and the style of output. This should help down the road with validation and keeping the data types consistent. And if things change you should only have to changes these dictionaries.
- copyright:
Jared Peacock (jpeacock@usgs.gov)
- license:
MIT