mt_metadata.processing.aurora.channel_nomenclature

Classes

`ExEnum`	str(object='') -> str
`EyEnum`	str(object='') -> str
`HxEnum`	str(object='') -> str
`HyEnum`	str(object='') -> str
`HzEnum`	str(object='') -> str
`SupportedNomenclatureEnum`	str(object='') -> str
`ChannelNomenclature`	Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.processing.aurora.channel_nomenclature.ExEnum

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

ex = 'ex'

e1 = 'e1'

e2 = 'e2'

e3 = 'e3'

e4 = 'e4'

class mt_metadata.processing.aurora.channel_nomenclature.EyEnum

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

ey = 'ey'

e1 = 'e1'

e2 = 'e2'

e3 = 'e3'

e4 = 'e4'

class mt_metadata.processing.aurora.channel_nomenclature.HxEnum

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

bx = 'bx'

hx = 'hx'

h1 = 'h1'

h2 = 'h2'

h3 = 'h3'

class mt_metadata.processing.aurora.channel_nomenclature.HyEnum

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

by = 'by'

hy = 'hy'

h1 = 'h1'

h2 = 'h2'

h3 = 'h3'

class mt_metadata.processing.aurora.channel_nomenclature.HzEnum

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

bz = 'bz'

hz = 'hz'

h1 = 'h1'

h2 = 'h2'

h3 = 'h3'

class mt_metadata.processing.aurora.channel_nomenclature.SupportedNomenclatureEnum

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

default = 'default'

lemi12 = 'lemi12'

lemi34 = 'lemi34'

musgraves = 'musgraves'

phoenix123 = 'phoenix123'

class mt_metadata.processing.aurora.channel_nomenclature.ChannelNomenclature(**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

ex: Annotated[ExEnum, Field(default='ex', description='label for the X electric field channel, X is assumed to be North', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['ex']})]

ey: Annotated[EyEnum, Field(default='ey', description='label for the Y electric field channel, Y is assumed to be East', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['ey']})]

hx: Annotated[HxEnum, Field(default='hx', description='label for the X magnetic field channel, X is assumed to be North', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['hx']})]

hy: Annotated[HyEnum, Field(default='hy', description='label for the Y magnetic field channel, Y is assumed to be East', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['hy']})]

hz: Annotated[HzEnum, Field(default='hz', description='label for the Z magnetic field channel, Z is assumed to be vertical Down', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['hz']})]

keyword: Annotated[SupportedNomenclatureEnum, Field(default=SupportedNomenclatureEnum.default, description='Keyword for the channel nomenclature system', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['default', 'lemi12', 'lemi34', 'musgraves', 'phoenix123']})]

classmethod check_keyword(value, info)

property ex_ey: list[str]

property hx_hy: list[str]

property hx_hy_hz: list[str]

property ex_ey_hz: list[str]

property default_input_channels: list[str]

property default_output_channels: list[str]

property default_reference_channels: list[str]

get_channel_map()

Based on self.keyword return the mapping between conventional channel names and the custom channel names in the particular nomenclature.

update()

Assign values to standard channel names “ex”, “ey” etc based on channel_map dict

unpack()

property channels: list[str]

model_post_init(__context): Called after model initialization to set up auto-update and do initial update.