pyforestry.base.taper package¶

Submodules¶

pyforestry.base.taper.taper module¶

class pyforestry.base.taper.taper.Taper(timber: Timber, taper_subclass_instance: Taper)[source]¶

Bases: object

General Taper class for subimplementations of different tapers.

get_diameter_at_height(height_m: float) → float[source]¶: Returns diameter under bark (cm) at a given height (m) from stump. This calls your subclass taper.get_diameter_at_height function.

get_diameter_vectorised(h_array: Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | ndarray) → ndarray[source]¶

get_height_at_diameter(diameter: float) → float[source]¶: Returns the height (m above stump) at which the tree reaches the specified diameter (cm).

volume_section(h1_m: float, h2_m: float) → float[source]¶: Integrate volume (m^3) from h1_m to h2_m above stump.

Module contents¶

Base taper models used to describe stem profiles.

class pyforestry.base.taper.Taper(timber: Timber, taper_subclass_instance: Taper)[source]¶

Bases: object

General Taper class for subimplementations of different tapers.

get_diameter_at_height(height_m: float) → float[source]¶: Returns diameter under bark (cm) at a given height (m) from stump. This calls your subclass taper.get_diameter_at_height function.

get_diameter_vectorised(h_array: Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | complex | bytes | str | _NestedSequence[complex | bytes | str] | ndarray) → ndarray[source]¶

get_height_at_diameter(diameter: float) → float[source]¶: Returns the height (m above stump) at which the tree reaches the specified diameter (cm).

volume_section(h1_m: float, h2_m: float) → float[source]¶: Integrate volume (m^3) from h1_m to h2_m above stump.