mt_metadata.processing.aurora.channel_nomenclature ================================================== .. py:module:: mt_metadata.processing.aurora.channel_nomenclature Classes ------- .. autoapisummary:: mt_metadata.processing.aurora.channel_nomenclature.ExEnum mt_metadata.processing.aurora.channel_nomenclature.EyEnum mt_metadata.processing.aurora.channel_nomenclature.HxEnum mt_metadata.processing.aurora.channel_nomenclature.HyEnum mt_metadata.processing.aurora.channel_nomenclature.HzEnum mt_metadata.processing.aurora.channel_nomenclature.SupportedNomenclatureEnum mt_metadata.processing.aurora.channel_nomenclature.ChannelNomenclature Module Contents --------------- .. py:class:: ExEnum Bases: :py:obj:`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'. .. py:attribute:: ex :value: 'ex' .. py:attribute:: e1 :value: 'e1' .. py:attribute:: e2 :value: 'e2' .. py:attribute:: e3 :value: 'e3' .. py:attribute:: e4 :value: 'e4' .. py:class:: EyEnum Bases: :py:obj:`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'. .. py:attribute:: ey :value: 'ey' .. py:attribute:: e1 :value: 'e1' .. py:attribute:: e2 :value: 'e2' .. py:attribute:: e3 :value: 'e3' .. py:attribute:: e4 :value: 'e4' .. py:class:: HxEnum Bases: :py:obj:`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'. .. py:attribute:: bx :value: 'bx' .. py:attribute:: hx :value: 'hx' .. py:attribute:: h1 :value: 'h1' .. py:attribute:: h2 :value: 'h2' .. py:attribute:: h3 :value: 'h3' .. py:class:: HyEnum Bases: :py:obj:`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'. .. py:attribute:: by :value: 'by' .. py:attribute:: hy :value: 'hy' .. py:attribute:: h1 :value: 'h1' .. py:attribute:: h2 :value: 'h2' .. py:attribute:: h3 :value: 'h3' .. py:class:: HzEnum Bases: :py:obj:`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'. .. py:attribute:: bz :value: 'bz' .. py:attribute:: hz :value: 'hz' .. py:attribute:: h1 :value: 'h1' .. py:attribute:: h2 :value: 'h2' .. py:attribute:: h3 :value: 'h3' .. py:class:: SupportedNomenclatureEnum Bases: :py:obj:`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'. .. py:attribute:: default :value: 'default' .. py:attribute:: lemi12 :value: 'lemi12' .. py:attribute:: lemi34 :value: 'lemi34' .. py:attribute:: musgraves :value: 'musgraves' .. py:attribute:: phoenix123 :value: 'phoenix123' .. py:class:: ChannelNomenclature(**data) Bases: :py:obj:`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. .. attribute:: _skip_equals Private attribute listing fields to skip in equality comparisons :type: list[str] .. attribute:: _fields Private attribute caching field information :type: dict[str, Any] .. rubric:: 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 .. py:attribute:: ex :type: 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']})] .. py:attribute:: ey :type: 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']})] .. py:attribute:: hx :type: 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']})] .. py:attribute:: hy :type: 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']})] .. py:attribute:: hz :type: 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']})] .. py:attribute:: keyword :type: 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']})] .. py:method:: check_keyword(value, info) :classmethod: .. py:property:: ex_ey :type: list[str] .. py:property:: hx_hy :type: list[str] .. py:property:: hx_hy_hz :type: list[str] .. py:property:: ex_ey_hz :type: list[str] .. py:property:: default_input_channels :type: list[str] .. py:property:: default_output_channels :type: list[str] .. py:property:: default_reference_channels :type: list[str] .. py:method:: get_channel_map() Based on self.keyword return the mapping between conventional channel names and the custom channel names in the particular nomenclature. .. py:method:: update() Assign values to standard channel names "ex", "ey" etc based on channel_map dict .. py:method:: unpack() .. py:property:: channels :type: list[str] .. py:method:: model_post_init(__context) Called after model initialization to set up auto-update and do initial update.