mt_metadata.transfer_functions.io.zonge.metadata.unit

Classes

Unit

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.io.zonge.metadata.unit.Unit(**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

length: Annotated[str, Field(default='m', description='Type of smoothing for phase slope algorithm', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['m']})]
e: Annotated[str, Field(default='mV/km', description='Units for the electric field', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': ['mV/km']})]
b: Annotated[str, Field(default='nT', description='Units for the magnetic field', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['nT']})]
classmethod validate_units(value, info)

validate units base on input string will return the long name

Parameters:

  • value (units string) – unit string separated by either ‘/’ for division or ‘ ‘ for multiplication. Or ‘per’ and ‘ ‘, respectively

  • info (ValidationInfo) – _description_

Returns:

return the long descriptive name of the unit. For example ‘kilometers’.

Return type:

str