pyforestry.base.timber package

Subpackages

• pyforestry.base.timber.timber_base package
  • Submodules
  • pyforestry.base.timber.timber_base.timber module
    • Timber
      • Timber.validate()
  • pyforestry.base.timber.timber_base.timber_volume_integrator module
    • TimberVolumeIntegrator
      • TimberVolumeIntegrator.cylinder_volume_integrand()
      • TimberVolumeIntegrator.integrate_volume()
  • Module contents
    • Timber
      • Timber.validate()
    • TimberVolumeIntegrator
      • TimberVolumeIntegrator.cylinder_volume_integrand()
      • TimberVolumeIntegrator.integrate_volume()

Module contents

Convenience re-exports for timber classes.

class pyforestry.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)

Bases: object

Representation of a single tree with minimal attributes.

validate() → None

Validate that the provided tree attributes are sensible.

class pyforestry.base.timber.TimberVolumeIntegrator

Bases: object

static cylinder_volume_integrand(height, taper_instance)

Calculate the cross-sectional area. Now takes a taper instance.

static integrate_volume(height1, height2, taper_instance)

Integrate the volume of the cylinder between two heights.