niamoto.core.plugins.transformers.extraction package

Submodules

niamoto.core.plugins.transformers.extraction.direct_attribute module

Plugin for getting a direct attribute from a source.

class niamoto.core.plugins.transformers.extraction.direct_attribute.DirectAttributeParams(*, source='occurrences', field, units='', max_value=None, format=None, precision=None)

Bases: BaseModel

Parameters for direct attribute extraction.

This plugin extracts a single field value directly from a data source.

Parameters:

  • source (str)

  • field (str)

  • units (str)

  • max_value (float | None)

  • format (Literal['number', 'percentage', 'text'] | None)

  • precision (int | None)

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'description': 'Extract a single attribute value from a data source', 'examples': [{'field': 'shannon', 'max_value': 5, 'source': 'plots', 'units': ''}, {'field': 'basal_area', 'format': 'number', 'max_value': 100, 'precision': 2, 'source': 'plots', 'units': 'm²/ha'}]}}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

source: str
field: str
units: str
max_value: float | None
format: Literal['number', 'percentage', 'text'] | None
precision: int | None
classmethod validate_max_value(v)

Ensure max_value is positive if provided.

class niamoto.core.plugins.transformers.extraction.direct_attribute.DirectAttributeConfig(*, plugin='direct_attribute', source=None, params)

Bases: PluginConfig

Complete configuration for direct attribute plugin.

Parameters:
plugin: Literal['direct_attribute']
params: DirectAttributeParams
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class niamoto.core.plugins.transformers.extraction.direct_attribute.DirectAttribute(db, registry=None)

Bases: TransformerPlugin

Plugin for getting a direct attribute

config_model

alias of DirectAttributeConfig

validate_config(config)

Validate configuration and return typed config.

Parameters:

config (Dict[str, Any])

Return type:

DirectAttributeConfig

transform(data, config)

Transform data according to configuration.

Parameters:

  • data (DataFrame | Dict[str, DataFrame])

  • config (Dict[str, Any])

Return type:

Dict[str, Any]

niamoto.core.plugins.transformers.extraction.geospatial_extractor module

niamoto.core.plugins.transformers.extraction.multi_column_extractor module

Module contents