mt_metadata.transfer_functions.tf.statistical_estimate

Classes

StatisticalEstimate

Base class for all metadata objects with Pydantic validation.

Module Contents

class mt_metadata.transfer_functions.tf.statistical_estimate.StatisticalEstimate(**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

name: Annotated[str, Field(default='', description='Name of the statistical estimate', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['transfer function']})]

data_type: Annotated[mt_metadata.common.enumerations.ArrayDTypeEnum, Field(default='complex', description='Type of number contained in the estimate', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['real']})]

description: Annotated[str, Field(default='', description='Description of the statistical estimate', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['this is an estimate']})]

input_channels: Annotated[list[str] | str, Field(default=[], description='List of input channels (sources)', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['hx, hy', ['hx', 'hy']]})]

output_channels: Annotated[list[str] | str, Field(default=[], description='List of output channels (response).', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['hx, hy', ['hx', 'hy']]})]

units: Annotated[str, Field(default='', description='Units of the estimate.', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': ['millivolts per kilometer per nanotesla']})]

classmethod validate_units(value)

classmethod validate_channels(value)

convert channels to a list of single channels