satellit_sam.core.allometry
satellit_sam.core.allometry
Auto-generated from
satellit_sam/src/satellit_sam/core/allometry.pybysatellit_sam/scripts/generate_api_docs.py.
Allometric conversion helpers for DBH and crown-radius estimation.
Functions
to_dbh_cm
def to_dbh_cm(dbh_raw: float, dbh_unit: DbhUnit) -> float:
Convert a DBH value into centimeters.
Arguments
dbh_raw: Raw DBH value from the input inventory. dbh_unit: Unit of ``dbh_raw`` (``mm``, ``cm``, or ``m``).
Returns
DBH value converted to centimeters.
compute_crown_radius_m
def compute_crown_radius_m(
dbh_cm: float,
crown_model: CrownModel,
linear_factor_m_per_cm: float,
linear_intercept_m: float,
power_a: float,
power_b: float,
min_crown_radius_m: float,
max_crown_radius_m: float,
) -> float:
Estimate crown radius from DBH and clamp to configured bounds.
Arguments
dbh_cm: Diameter at breast height in centimeters. crown_model: Regression family used for the estimate. linear_factor_m_per_cm: Slope used by the ``linear`` model. linear_intercept_m: Intercept used by the ``linear`` model. power_a: Multiplicative coefficient used by the ``power`` model. power_b: Exponent used by the ``power`` model. min_crown_radius_m: Lower bound for the returned radius. max_crown_radius_m: Upper bound for the returned radius.
Returns
Estimated crown radius in meters.
Classes
No public classes.