mt_metadata.transfer_functions.io.zfiles.metadata.channel

Classes

Channel

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.io.zfiles.metadata.channel.Channel(**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

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

azimuth: Annotated[float, Field(default=0.0, description='channel azimuth', alias=None, json_schema_extra={'units': 'degrees', 'required': True, 'examples': ['90']})]

tilt: Annotated[float, Field(default=0.0, description='channel tilt relative to horizontal.', alias=None, json_schema_extra={'units': 'degrees', 'required': True, 'examples': ['100.0']})]

dl: Annotated[float | str, Field(default=0.0, description='dipole length in meters', alias=None, json_schema_extra={'units': 'meters', 'required': True, 'examples': ['0.0']})]

channel: Annotated[mt_metadata.common.enumerations.ChannelEnum, Field(default='', description='channel name', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['hx']})]

property channel_string: str

Return the channel name as a string for indexing purposes.

property index

from_dict(channel_dict): fill attributes from a dictionary