Configuration API

The config module contains configuration settings for the Hydro-Topo Features package.

Configuration settings for the hydro-topological features package.

class Config(project_name: str = 'Hydro-Topo Features', project_version: str = '0.1.4', paths: ~hydro_topo_features.config.Paths = <factory>, output_dir: ~pathlib.Path = PosixPath('outputs'), directory_structure: ~typing.Dict[str, str] = <factory>, dem_processing: ~typing.Dict[str, ~typing.Any] = <factory>, osm_water_tags: ~typing.Dict[str, ~typing.List[str]] = <factory>, feature_params: ~typing.Dict[str, ~typing.Dict[str, ~typing.Any]] = <factory>, static_vis: ~typing.Dict[str, ~typing.Any] = <factory>, interactive_vis: ~typing.Dict[str, ~typing.Any] = <factory>, raster_vis: ~typing.Dict[str, ~typing.Dict[str, ~typing.Any]] = <factory>)[source]

Bases: object

Main configuration class for hydro-topographical feature extraction

__post_init__()[source]: Initialize the output directory structure

dem_processing: Dict[str, Any]

directory_structure: Dict[str, str]

feature_params: Dict[str, Dict[str, Any]]

interactive_vis: Dict[str, Any]

osm_water_tags: Dict[str, List[str]]

output_dir: Path = PosixPath('outputs')

paths: Paths

project_name: str = 'Hydro-Topo Features'

project_version: str = '0.1.4'

raster_vis: Dict[str, Dict[str, Any]]

static_vis: Dict[str, Any]

class Paths(dem: str = None, aoi: str = None, output_dir: str = 'outputs')[source]

Bases: object

Configuration class for file paths

aoi: str = None

dem: str = None

output_dir: str = 'outputs'

Project Settings

PROJECT_NAME: Name of the project
PROJECT_VERSION: Version of the package

Directory Structure

DIRECTORY_STRUCTURE: Dictionary defining the directory structure for outputs

DEM Processing

DEM_PROCESSING: Dictionary with parameters for DEM processing, including stream burning depth, nodata values, etc.

Feature Parameters

FEATURE_PARAMS: Dictionary with parameters for computing HAND, slope, and EDTW

Visualization Settings

RASTER_VIS: Dictionary with settings for visualizing different rasters