niamoto.core.plugins.transformers.ecological package

Submodules

niamoto.core.plugins.transformers.ecological.custom_calculator module

niamoto.core.plugins.transformers.ecological.custom_formatter module

niamoto.core.plugins.transformers.ecological.elevation_profile module

Plugin for creating elevation profiles for shapes. Analyzes the altitude distribution and allows for overlaying forest coverage to create complete altitude distribution graphs.

class niamoto.core.plugins.transformers.ecological.elevation_profile.ElevationProfileConfig(*, plugin='elevation_profile', source=None, params=<factory>)

Bases: PluginConfig

Configuration for the elevation profile plugin

Parameters:
  • plugin (str)

  • source (str | None)

  • params (Dict[str, Any])

plugin: str
params: Dict[str, Any]
classmethod validate_paths(v)

Validates the paths to the source data.

model_config: ClassVar[ConfigDict] = {}

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

class niamoto.core.plugins.transformers.ecological.elevation_profile.ElevationProfile(db, registry=None)

Bases: TransformerPlugin

Plugin for creating elevation profiles.

This plugin analyzes the altitude distribution of a geographic zone using a Digital Elevation Model (DEM). It can also overlay this analysis with a forest coverage layer to study the distribution of the forest by altitude.

The results are formatted for visualization as a graph showing the distribution of surfaces by altitude class, with optional overlay of the forest.

Parameters:
  • db (Any)

  • registry (Any | None)

config_model

alias of ElevationProfileConfig

validate_config(config)

Validates the plugin configuration.

Parameters:

config (Dict[str, Any])

Return type:

Dict[str, Any]

transform(data, config)

Creates an elevation profile for a shape.

Parameters:
  • data (DataFrame) – GeoDataFrame containing the shape

  • config (Dict[str, Any]) – Configuration with paths and options

Returns:

Dictionary with the elevation profile and optionally the forest distribution

Return type:

Dict[str, Any]

niamoto.core.plugins.transformers.ecological.forest_elevation module

niamoto.core.plugins.transformers.ecological.forest_holdridge module

niamoto.core.plugins.transformers.ecological.fragmentation module

niamoto.core.plugins.transformers.ecological.land_use module

Module contents