mt_metadata.transfer_functions.io.zonge.metadata.header

Classes

Header

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.io.zonge.metadata.header.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