mt_metadata.transfer_functions.io.zonge.metadata

Submodules

Classes

`Auto`	Base class for all metadata objects with Pydantic validation.
`CH`	Base class for all metadata objects with Pydantic validation.
`DPlus`	Base class for all metadata objects with Pydantic validation.
`GDP`	Base class for all metadata objects with Pydantic validation.
`GPS`	Base class for all metadata objects with Pydantic validation.
`Job`	Base class for all metadata objects with Pydantic validation.
`Line`	Base class for all metadata objects with Pydantic validation.
`MTFT24`	Base class for all metadata objects with Pydantic validation.
`PhaseSlope`	Base class for all metadata objects with Pydantic validation.
`Rx`	Base class for all metadata objects with Pydantic validation.
`STN`	Base class for all metadata objects with Pydantic validation.
`Survey`	Base class for all metadata objects with Pydantic validation.
`Tx`	Base class for all metadata objects with Pydantic validation.
`TypeEnum`	str(object='') -> str
`Unit`	Base class for all metadata objects with Pydantic validation.
`MTEdit`	Base class for all metadata objects with Pydantic validation.
`Header`	Base class for all metadata objects with Pydantic validation.

Package Contents

class mt_metadata.transfer_functions.io.zonge.metadata.Auto(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

phase_flip: 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']})]

class mt_metadata.transfer_functions.io.zonge.metadata.CH(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

a_d_card_s_n: 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']})]

gdp_box: 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']})]

stn: 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']})]

number: 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']})]

cmp: 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']})]

c_res: 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']})]

azimuth: 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']})]

incl: 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']})]

classmethod validate_comma_separated_fields(v): Validate fields that may contain comma-separated values. Returns a list when commas are found, otherwise returns the string as-is.

class mt_metadata.transfer_functions.io.zonge.metadata.DPlus(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

use: 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']})]

class mt_metadata.transfer_functions.io.zonge.metadata.GDP(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

date: 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']})]

time: 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']})]

type: Annotated[str | None, Field(default=None, description='Type of GPD', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['zen']})]

prog_ver: Annotated[str | None, Field(default=None, description='version of hadware in the GDP', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [0]})]

classmethod validate_date(field_value)

classmethod validate_time(field_value)

class mt_metadata.transfer_functions.io.zonge.metadata.GPS(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

lat: Annotated[float, Field(default=0.0, description='latitude', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['10.3']})]

lon: Annotated[float, Field(default=0.0, description='longitude', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['10.3']})]

datum: Annotated[str, Field(default='WGS84', description='Datum of the location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['WGS84']})]

u_t_m_zone: Annotated[int, Field(default=0, description='UTM zone of location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['12']})]

classmethod validate_datum(value)

Validate the datum value and convert it to the appropriate enum type.

classmethod validate_position(value, info)

class mt_metadata.transfer_functions.io.zonge.metadata.Job(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

name: Annotated[str | None, Field(default=None, description='name of the job', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['yellowstone']})]

job_for: Annotated[str | None, Field(default=None, description='who the job is for', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['NSF']})]

class mt_metadata.transfer_functions.io.zonge.metadata.Line(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

name: 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']})]

number: Annotated[int | None, Field(default=None, description='Line number', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [0]})]

class mt_metadata.transfer_functions.io.zonge.metadata.MTFT24(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

version: 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']})]

class mt_metadata.transfer_functions.io.zonge.metadata.PhaseSlope(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

smooth: 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']})]

to_z_mag: 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']})]

class mt_metadata.transfer_functions.io.zonge.metadata.Rx(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

gdp_stn: Annotated[str, Field(default='', description='Station name', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['24']})]

length: Annotated[float, Field(default=0.0, description='Generic dipole length', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['100']})]

h_p_r: Annotated[list[float], Field(default=[], description='Horizontal, pitch, roll of array', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['0, 0, 180']})]

cmp: Annotated[CmpEnum, Field(default='', description='processed component of impedance or tipper', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['zxx']})]

center: 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']})]

x_y_z1: 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']})]

x_y_z2: 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']})]

u_t_m1: 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']})]

a_space: Annotated[str | None, Field(default=None, description='spacing of lines', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['100 m']})]

s_space: Annotated[str | None, Field(default=None, description='spacing of stations along the line', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['100']})]

class mt_metadata.transfer_functions.io.zonge.metadata.STN(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

name: Annotated[str, Field(default='', description='name of the station', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['1']})]

class mt_metadata.transfer_functions.io.zonge.metadata.Survey(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

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']})]

array: Annotated[ArrayEnum, Field(default=ArrayEnum.tensor, description='Type of array', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['tensor']})]

datum: Annotated[str, Field(default='WGS84', description='Datum of the location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['WGS84']})]

u_t_m_zone: Annotated[int, Field(default=0, description='UTM zone of location', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['12']})]

proj: Annotated[ProjEnum, Field(default=ProjEnum.UTM, description='Projection of the location coordinates', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['UTM']})]

classmethod validate_datum(value)

Validate the datum value and convert it to the appropriate enum type.

class mt_metadata.transfer_functions.io.zonge.metadata.Tx(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

type: Annotated[TypeEnum, Field(default=TypeEnum.natural, description='Type of EM source', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['natural']})]

class mt_metadata.transfer_functions.io.zonge.metadata.TypeEnum

Bases: 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’.

natural = 'natural'

controlled_source = 'controlled source'

class mt_metadata.transfer_functions.io.zonge.metadata.Unit(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

length: Annotated[str, Field(default='m', description='Type of smoothing for phase slope algorithm', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['m']})]

e: Annotated[str, Field(default='mV/km', description='Units for the electric field', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['mV/km']})]

b: Annotated[str, Field(default='nT', description='Units for the magnetic field', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['nT']})]

classmethod validate_units(value, info)

validate units base on input string will return the long name

Parameters:

value (units string) – unit string separated by either ‘/’ for division or ‘ ‘ for multiplication. Or ‘per’ and ‘ ‘, respectively
info (ValidationInfo) – _description_

Returns:

return the long descriptive name of the unit. For example ‘kilometers’.

Return type:

str

class mt_metadata.transfer_functions.io.zonge.metadata.MTEdit(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

version: 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']})]

auto: 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'}]})]

d_plus: 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'}]})]

phase_slope: 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'}]})]

class mt_metadata.transfer_functions.io.zonge.metadata.Header(**data)

Bases: 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.

_skip_equals

Private attribute listing fields to skip in equality comparisons

Type:: list[str]

_fields

Private attribute caching field information

Type:: dict[str, Any]

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

name: Annotated[str | None, Field(default=None, description='Station name', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})]

survey: 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']})]

tx: 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']})]

rx: 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']})]

m_t_edit: 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']})]

m_t_f_t24: 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']})]

gps: 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']})]

gdp: 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']})]

ch: 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']})]

stn: 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']})]

line: 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']})]

unit: 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']})]

job: 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']})]

elevation: Annotated[float, Field(default=0.0, description='Elevation metadata', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['null']})]

read_header(lines)

Read the header of an AVG file and fill attributes accordingly

Parameters:: lines (list[str]) – list of strings representing the lines of the AVG file
Return type:: list[str]

classmethod validate_elevation(v): Validate and convert elevation input.

classmethod validate_coordinates(v): Validate and convert coordinate input.

property latitude: float

Get latitude from GPS data.

property longitude: float

Get longitude from GPS data.

property easting: float | None

Get easting from center location.

property northing: float | None

Get northing from center location.

property center_location: list[float] | None

Get center location from component data.

property datum: str | None

Get datum from GPS data.

property utm_zone: str | None

Get UTM zone from GPS data.

property station: str | None

Get station from RX data.

property instrument_id: str | None

Get instrument ID from component data.

property instrument_type: str | None

Get instrument type from GDP data.

property firmware: str | None

Get firmware version from GDP data.

property start_time: str | None

Get start time from GDP data.

property g_p_s: Alias for GPS object to maintain backward compatibility.

property g_d_p: Alias for GDP object to maintain backward compatibility.

write_header()

Write .avg header lines

Returns:: DESCRIPTION
Return type:: TYPE