Criteria Documentation
This directory contains the scientific documentation for the criteria modules used in BlueGreenCity-KI. Each criterion page should explain what is measured, which data are required, how raw values are transformed into risk scores, and which metadata are written to the output.
For the aggregation of individual criteria into the final static drought-risk score, see ../risk_assessment_static/risk_scoring_guide.md.
Scope
- All criteria currently registered in the code catalog are documented.
- Some modules provide more than one configured variant, for example day, night, and UHI temperature or sky view factor and sunlit hours.
- The active configuration, weights, and parameter values are defined in ../../config/config.yaml.
Criteria by Topic
Climate and Microclimate
- air_temperature.md - Temperature-based assessment with the registered variants air_temperature_day, air_temperature_night, and uhi_intensity
- albedo.md - Surface reflectance from UrbanGreenEye as a remote-sensing proxy for heat-absorbing urban fabric
- cold_air.md - Cold-air production and cold-air volume flow from urban climate models
- building_shading.md - Building-related shading with the registered variants sky_view_factor and sunlit_hours
- dwsi.md - UrbanGreenEye canopy water-stress proxy with year-aware raster selection
- seasonal_weather.md - Neutral DWD seasonal weather context features for the AutoML workflow
Soil Water and Site Conditions
- field_capacity.md - Plant-available field capacity in the effective root zone
- groundwater.md - Groundwater depth and optional trend adjustment
- land_use.md - Site context derived from land-use classes
- gk25.md - Shallow-subsurface geology (GK25) as water storage and drainage proxy for the root zone
Tree Attributes and Vitality
- age.md - Age-related risk assessment
- vitality.md - Vitality stage with watering-related exclusion logic
Species-Specific Tolerance
- drought_tolerance.md - Species-level drought tolerance with config-driven score mapping from Citree enrichment fields
- heat_tolerance.md - Species-level heat tolerance with config-driven score mapping from Citree enrichment fields
Vegetation Condition
- ndvi.md - Vegetation status derived from CIR imagery, optionally including multi-temporal comparison
Spatial Context and Exposure
- street_type.md - Traffic-related exposure based on OSM and ALKIS road classes
- planting_structure.md - Local neighbor density and spatial isolation based on direct neighbor counts
- salt.md - Salt exposure derived from winter-service classes
- subway_tunnel.md - Proximity to underground Stadtbahn/subway tunnels limiting rooting volume
- construction_sites.md - Proximity to active road construction sites (OSM
highway=construction)
Root Zone and Tree Pit Conditions
Registered Criterion Names
The code-level registry is maintained in ../../bluegreencity_ki/criteria/criteria_catalog.py. The current catalog contains:
- age
- street_type
- vitality
- planting_structure
- air_temperature_day
- air_temperature_night
- uhi_intensity
- albedo
- land_use
- ndvi
- dwsi
- seasonal_weather
- drought_tolerance
- heat_tolerance
- salt
- pit_size
- tree_disc
- cold_air
- construction_sites
- field_capacity
- gk25
- groundwater
- sky_view_factor
- subway_tunnel
- sunlit_hours
- criteria_features_overview.md - Cross-reference table of all features (criteria, CiTree, OBSkH) with their usage in the rule-based pipeline and the AutoML model
Recommended Page Structure
Each criterion page should remain concise but scientifically traceable:
- Objective and interpretation
- Input data and data source
- Processing and scoring logic
- Configuration in config.yaml
- Output fields and metadata
- Validation and limitations
Keep methodological detail where it is required for scientific transparency. Operational setup details belong in the technical documentation under docs, not in the criterion pages.
Use the shared template in ../../templates/criterion_documentation_template.md for new or revised criterion pages.
Maintenance Workflow
When a criterion changes:
- Update or add the module in bluegreencity_ki/criteria.
- Update the relevant section in config/config.yaml.
- Add or adapt tests under tests.
- Update the criterion page in this folder.
- Verify that this overview still matches the code catalog and the active configuration.