mt_metadata.transfer_functions.io.zonge.metadata ================================================ .. py:module:: mt_metadata.transfer_functions.io.zonge.metadata Submodules ---------- .. toctree:: :maxdepth: 1 /source/api/mt_metadata/transfer_functions/io/zonge/metadata/auto/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/ch/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/d_plus/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/gdp/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/gps/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/header/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/job/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/line/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/mt_edit/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/mtft24/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/phase_slope/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/rx/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/stn/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/survey/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/tx/index /source/api/mt_metadata/transfer_functions/io/zonge/metadata/unit/index Classes ------- .. autoapisummary:: mt_metadata.transfer_functions.io.zonge.metadata.Auto mt_metadata.transfer_functions.io.zonge.metadata.CH mt_metadata.transfer_functions.io.zonge.metadata.DPlus mt_metadata.transfer_functions.io.zonge.metadata.GDP mt_metadata.transfer_functions.io.zonge.metadata.GPS mt_metadata.transfer_functions.io.zonge.metadata.Job mt_metadata.transfer_functions.io.zonge.metadata.Line mt_metadata.transfer_functions.io.zonge.metadata.MTFT24 mt_metadata.transfer_functions.io.zonge.metadata.PhaseSlope mt_metadata.transfer_functions.io.zonge.metadata.Rx mt_metadata.transfer_functions.io.zonge.metadata.STN mt_metadata.transfer_functions.io.zonge.metadata.Survey mt_metadata.transfer_functions.io.zonge.metadata.Tx mt_metadata.transfer_functions.io.zonge.metadata.TypeEnum mt_metadata.transfer_functions.io.zonge.metadata.Unit mt_metadata.transfer_functions.io.zonge.metadata.MTEdit mt_metadata.transfer_functions.io.zonge.metadata.Header Package Contents ---------------- .. py:class:: Auto(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: phase_flip :type: Annotated[mt_metadata.common.enumerations.YesNoEnum, Field(default=YesNoEnum.yes, description='Was phase automatically flipped in processing', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['yes']})] .. py:class:: CH(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: a_d_card_s_n :type: Annotated[str | list[str] | None, Field(default=None, description='serial number of ad card for local and remote stations', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['6545BAC6,BE380864']})] .. py:attribute:: gdp_box :type: Annotated[str | list[str] | None, Field(default=None, description='Box number for local and remote stations', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['18,15']})] .. py:attribute:: stn :type: Annotated[str | list[str] | None, Field(default=None, description='station number of local and remote', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['1,2']})] .. py:attribute:: number :type: Annotated[str | list[str] | None, Field(default=None, description='channel number for local and coil number of remote', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['1, 2284']})] .. py:attribute:: cmp :type: Annotated[str | list[str] | None, Field(default=None, description='component of local and remote stations', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['ex,hy']})] .. py:attribute:: c_res :type: Annotated[str | list[str] | None, Field(default=None, description='contact resistance for local and remote sensors', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['0,0']})] .. py:attribute:: azimuth :type: Annotated[str | list[str] | None, Field(default=None, description='azimuth for local and remote sensors', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['12.1,12.1']})] .. py:attribute:: incl :type: Annotated[str | list[str] | None, Field(default=None, description='Inclination ', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2']})] .. py:method:: validate_comma_separated_fields(v) :classmethod: Validate fields that may contain comma-separated values. Returns a list when commas are found, otherwise returns the string as-is. .. py:class:: DPlus(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: use :type: Annotated[mt_metadata.common.enumerations.YesNoEnum, Field(default=YesNoEnum.no, description='Was D+ used to smooth the response', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['no']})] .. py:class:: GDP(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: date :type: Annotated[mt_metadata.common.mttime.MTime | str | float | int | numpy.datetime64 | pandas.Timestamp | None, Field(default_factory=lambda: MTime(time_stamp=None).date, description='start date of the measurement', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['01/01/2020']})] .. py:attribute:: time :type: Annotated[mt_metadata.common.mttime.MTime | str | float | int | numpy.datetime64 | pandas.Timestamp | None, Field(default_factory=lambda: MTime(time_stamp=None), description='start time of the measurement', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['12:00:00']})] .. py:attribute:: type :type: Annotated[str | None, Field(default=None, description='Type of GPD', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['zen']})] .. py:attribute:: prog_ver :type: Annotated[str | None, Field(default=None, description='version of hadware in the GDP', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [0]})] .. py:method:: validate_date(field_value) :classmethod: .. py:method:: validate_time(field_value) :classmethod: .. py:class:: GPS(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: lat :type: Annotated[float, Field(default=0.0, description='latitude', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['10.3']})] .. py:attribute:: lon :type: Annotated[float, Field(default=0.0, description='longitude', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['10.3']})] .. py:attribute:: datum :type: Annotated[str, Field(default='WGS84', description='Datum of the location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['WGS84']})] .. py:attribute:: u_t_m_zone :type: Annotated[int, Field(default=0, description='UTM zone of location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['12']})] .. py:method:: validate_datum(value) :classmethod: Validate the datum value and convert it to the appropriate enum type. .. py:method:: validate_position(value, info) :classmethod: .. py:class:: Job(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: name :type: Annotated[str | None, Field(default=None, description='name of the job', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['yellowstone']})] .. py:attribute:: job_for :type: Annotated[str | None, Field(default=None, description='who the job is for', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['NSF']})] .. py:class:: Line(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: name :type: Annotated[str | None, Field(default=None, description='Name of the line data collected on', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['0']})] .. py:attribute:: number :type: Annotated[int | None, Field(default=None, description='Line number', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [0]})] .. py:class:: MTFT24(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: version :type: Annotated[str, Field(default='', description='Version of MT Edit and date', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['3.10m applied 2021/01/27']})] .. py:class:: PhaseSlope(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: smooth :type: Annotated[SmoothEnum, Field(default=SmoothEnum.null, description='Type of smoothing for phase slope algorithm', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['robust']})] .. py:attribute:: to_z_mag :type: Annotated[mt_metadata.common.enumerations.YesNoEnum, Field(default=YesNoEnum.no, description='Was hz used for smoothing for phase slope algorithm', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['no']})] .. py:class:: Rx(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: gdp_stn :type: Annotated[str, Field(default='', description='Station name', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['24']})] .. py:attribute:: length :type: Annotated[float, Field(default=0.0, description='Generic dipole length', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['100']})] .. py:attribute:: h_p_r :type: Annotated[list[float], Field(default=[], description='Horizontal, pitch, roll of array', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['0, 0, 180']})] .. py:attribute:: cmp :type: Annotated[CmpEnum, Field(default='', description='processed component of impedance or tipper', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['zxx']})] .. py:attribute:: center :type: Annotated[str | None, Field(default=None, description='center of the sounding location', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2 m']})] .. py:attribute:: x_y_z1 :type: Annotated[str | None, Field(default=None, description='xyz of local station', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2']})] .. py:attribute:: x_y_z2 :type: Annotated[str | None, Field(default=None, description='xyz of remote station', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2']})] .. py:attribute:: u_t_m1 :type: Annotated[str | None, Field(default=None, description='UTM location of local station', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['335754.685:4263553.435:1650.2']})] .. py:attribute:: a_space :type: Annotated[str | None, Field(default=None, description='spacing of lines', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['100 m']})] .. py:attribute:: s_space :type: Annotated[str | None, Field(default=None, description='spacing of stations along the line', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['100']})] .. py:class:: STN(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: name :type: Annotated[str, Field(default='', description='name of the station', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['1']})] .. py:class:: Survey(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: type :type: Annotated[mt_metadata.common.enumerations.DataTypeEnum, Field(default=DataTypeEnum.NSAMT, description='Type of EM survey', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['nsamt']})] .. py:attribute:: array :type: Annotated[ArrayEnum, Field(default=ArrayEnum.tensor, description='Type of array', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['tensor']})] .. py:attribute:: datum :type: Annotated[str, Field(default='WGS84', description='Datum of the location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['WGS84']})] .. py:attribute:: u_t_m_zone :type: Annotated[int, Field(default=0, description='UTM zone of location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['12']})] .. py:attribute:: proj :type: Annotated[ProjEnum, Field(default=ProjEnum.UTM, description='Projection of the location coordinates', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['UTM']})] .. py:method:: validate_datum(value) :classmethod: Validate the datum value and convert it to the appropriate enum type. .. py:class:: Tx(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: type :type: Annotated[TypeEnum, Field(default=TypeEnum.natural, description='Type of EM source', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['natural']})] .. py:class:: TypeEnum Bases: :py:obj:`mt_metadata.common.enumerations.StrEnumerationBase` str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'. .. py:attribute:: natural :value: 'natural' .. py:attribute:: controlled_source :value: 'controlled source' .. py:class:: Unit(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: length :type: Annotated[str, Field(default='m', description='Type of smoothing for phase slope algorithm', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['m']})] .. py:attribute:: e :type: Annotated[str, Field(default='mV/km', description='Units for the electric field', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['mV/km']})] .. py:attribute:: b :type: Annotated[str, Field(default='nT', description='Units for the magnetic field', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['nT']})] .. py:method:: validate_units(value, info) :classmethod: validate units base on input string will return the long name :param value: unit string separated by either '/' for division or ' ' for multiplication. Or 'per' and ' ', respectively :type value: units string :param info: _description_ :type info: ValidationInfo :returns: return the long descriptive name of the unit. For example 'kilometers'. :rtype: str .. py:class:: MTEdit(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: version :type: Annotated[str, Field(default='', description='Version of MT Edit and date', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['3.10m applied 2021/01/27']})] .. py:attribute:: auto :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.Auto, Field(default_factory=Auto, description='Auto metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [{'param1': 'value1', 'param2': 'value2'}]})] .. py:attribute:: d_plus :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.DPlus, Field(default_factory=DPlus, description='DPlus metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [{'param1': 'value1', 'param2': 'value2'}]})] .. py:attribute:: phase_slope :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.PhaseSlope, Field(default_factory=PhaseSlope, description='PhaseSlope metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [{'param1': 'value1', 'param2': 'value2'}]})] .. py:class:: Header(**data) Bases: :py:obj:`mt_metadata.base.MetadataBase` Base class for all metadata objects with Pydantic validation. MetadataBase extends DotNotationBaseModel (which inherits from Pydantic's BaseModel) to provide automatic validation according to metadata standards. It adds functionality beyond dictionaries, supporting JSON, XML, pandas Series, and other formats for metadata interchange. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: Notes - All field assignments are validated automatically via Pydantic - None values are converted to appropriate defaults (empty string or 0.0) - Supports nested attribute access via dot notation - Thread-safe for read operations after initialization .. py:attribute:: name :type: Annotated[str | None, Field(default=None, description='Station name', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: survey :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.Survey, Field(default_factory=Survey, description='Survey metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: tx :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.Tx, Field(default_factory=Tx, description='Transmitter metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: rx :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.Rx, Field(default_factory=Rx, description='Receiver metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: m_t_edit :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.MTEdit, Field(default_factory=MTEdit, description='MTEdit metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: m_t_f_t24 :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.MTFT24, Field(default_factory=MTFT24, description='MTFT24 metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: gps :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.GPS, Field(default_factory=GPS, description='GPS metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: gdp :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.GDP, Field(default_factory=GDP, description='GDP metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: ch :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.CH, Field(default_factory=CH, description='CH metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: stn :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.STN, Field(default_factory=STN, description='STN metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: line :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.Line, Field(default_factory=Line, description='Line metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: unit :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.Unit, Field(default_factory=Unit, description='Unit metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: job :type: Annotated[mt_metadata.transfer_functions.io.zonge.metadata.Job, Field(default_factory=Job, description='Job metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:attribute:: elevation :type: Annotated[float, Field(default=0.0, description='Elevation metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})] .. py:method:: read_header(lines) Read the header of an AVG file and fill attributes accordingly :param lines: list of strings representing the lines of the AVG file :type lines: list[str] :rtype: list[str] .. py:method:: validate_elevation(v) :classmethod: Validate and convert elevation input. .. py:method:: validate_coordinates(v) :classmethod: Validate and convert coordinate input. .. py:property:: latitude :type: float Get latitude from GPS data. .. py:property:: longitude :type: float Get longitude from GPS data. .. py:property:: easting :type: Optional[float] Get easting from center location. .. py:property:: northing :type: Optional[float] Get northing from center location. .. py:property:: center_location :type: Optional[list[float]] Get center location from component data. .. py:property:: datum :type: Optional[str] Get datum from GPS data. .. py:property:: utm_zone :type: Optional[str] Get UTM zone from GPS data. .. py:property:: station :type: Optional[str] Get station from RX data. .. py:property:: instrument_id :type: Optional[str] Get instrument ID from component data. .. py:property:: instrument_type :type: Optional[str] Get instrument type from GDP data. .. py:property:: firmware :type: Optional[str] Get firmware version from GDP data. .. py:property:: start_time :type: Optional[str] Get start time from GDP data. .. py:property:: g_p_s Alias for GPS object to maintain backward compatibility. .. py:property:: g_d_p Alias for GDP object to maintain backward compatibility. .. py:method:: write_header() Write .avg header lines :return: DESCRIPTION :rtype: TYPE