mt_metadata.transfer_functions.io.emtfxml.metadata.dipole

Classes

Dipole

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.io.emtfxml.metadata.dipole.Dipole(**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

manufacturer: Annotated[str | None, Field(default=None, description='Name of the manufacturer of the instrument', json_schema_extra={'units': None, 'required': False, 'examples': ['MT Gurus']})]
length: Annotated[float | None, Field(default=None, description='Dipole length', json_schema_extra={'units': 'meters', 'required': False, 'examples': ['100.0']})]
azimuth: Annotated[float | None, Field(default=None, description='Azimuth of the dipole relative to coordinate system', json_schema_extra={'units': 'degrees', 'required': False, 'examples': ['90']})]
name: Annotated[str | None, Field(default=None, description='Name of the dipole', json_schema_extra={'units': None, 'required': False, 'examples': ['dipole1']})]
type: Annotated[str | None, Field(default=None, description='type of dipole', json_schema_extra={'units': None, 'required': False, 'examples': ['wire']})]
electrode: Annotated[list[mt_metadata.transfer_functions.io.emtfxml.metadata.Electrode], Field(default_factory=list, description='List of electrodes that make up the dipole', alias=None, json_schema_extra={'units': None, 'required': False, 'examples': [{'name': 'ex', 'type': 'wire'}]})]
validate_electrode(value)

Validate that the value is a list of Electrode objects.

to_xml(string=False, required=True)
Parameters:

  • string (TYPE, optional) – DESCRIPTION, defaults to False

  • required (TYPE, optional) – DESCRIPTION, defaults to True

Returns:

DESCRIPTION

Return type:

TYPE