mt_metadata.transfer_functions.io.zonge.metadata.ch

Classes

CH	Base class for all metadata objects with Pydantic validation.

Module Contents

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