pyforestry.base.timber.timber_base package¶

Submodules¶

pyforestry.base.timber.timber_base.timber module¶

Basic container class for individual tree parameters.

class pyforestry.base.timber.timber_base.timber.Timber(species: str, diameter_cm: float, height_m: float, double_bark_mm: float | None = None, crown_base_height_m: float | None = None, over_bark: bool | None = None, stump_height_m: float | None = 0.3)[source]¶

Bases: object

Representation of a single tree with minimal attributes.

validate() → None[source]¶: Validate that the provided tree attributes are sensible.

pyforestry.base.timber.timber_base.timber_volume_integrator module¶

class pyforestry.base.timber.timber_base.timber_volume_integrator.TimberVolumeIntegrator[source]¶

Bases: object

static cylinder_volume_integrand(height, taper_instance)[source]¶: Calculate the cross-sectional area. Now takes a taper instance.

static integrate_volume(height1, height2, taper_instance)[source]¶: Integrate the volume of the cylinder between two heights.

Module contents¶

class pyforestry.base.timber.timber_base.Timber(species: str, diameter_cm: float, height_m: float, double_bark_mm: float | None = None, crown_base_height_m: float | None = None, over_bark: bool | None = None, stump_height_m: float | None = 0.3)[source]¶

Bases: object

Representation of a single tree with minimal attributes.

validate() → None[source]¶: Validate that the provided tree attributes are sensible.

class pyforestry.base.timber.timber_base.TimberVolumeIntegrator[source]¶

Bases: object

static cylinder_volume_integrand(height, taper_instance)[source]¶: Calculate the cross-sectional area. Now takes a taper instance.

static integrate_volume(height1, height2, taper_instance)[source]¶: Integrate the volume of the cylinder between two heights.