v0.4.0 - Rumple Index
What's Changed
This release adds canopy rumple index support to PyForestScan.
Added
- Added
calculate_rumple()for computing canopy rumple index from a CHM. - Rumple is calculated as canopy surface area divided by planar ground area.
- Supports optional
min_heightmasking to exclude low vegetation before calculating canopy surface complexity. - Added rumple documentation under forest structure metrics.
- Added rumple to the public package API.
- Added tests covering flat surfaces, sloped surfaces, rough surfaces, invalid inputs,
min_heightmasking, and no-valid-surface cases.
Notes
Rumple returns a single scalar value for a CHM, not a raster. A flat canopy has a rumple value near 1.0; increasingly complex canopy surfaces have values greater than 1.0.
Verification
pytest tests/test_calculate.py -k rumple: 6 passedpytest tests/test_calculate.py: 54 passed