Source code for pyforestry.base.timber.timber_base.timber

"""Basic container class for individual tree parameters."""

from typing import Optional




class Timber:
    """Representation of a single tree with minimal attributes."""

    def __init__(
        self,
        species: str,
        diameter_cm: float,
        height_m: float,
        double_bark_mm: Optional[float] = None,
        crown_base_height_m: Optional[float] = None,
        over_bark: Optional[bool] = None,
        stump_height_m: Optional[float] = 0.3,
    ):
        self.species = species.lower()
        self.diameter_cm = diameter_cm
        self.height_m = height_m
        self.double_bark_mm = double_bark_mm
        self.crown_base_height_m = crown_base_height_m
        self.over_bark = over_bark
        self.stump_height_m = stump_height_m

        self.validate()



    def validate(self) -> None:
        """Validate that the provided tree attributes are sensible."""

        if self.height_m <= 0:
            raise ValueError("Height must be larger than 0 m: {self.height_m}")

        if self.diameter_cm < 0:
            raise ValueError("Diameter must be larger or equal to than 0 cm: {self.diameter_cm}")

        if (
            self.crown_base_height_m is not None
            and self.height_m is not None
            and self.crown_base_height_m >= self.height_m
        ):
            raise ValueError(
                (
                    f"Crown base height ({self.crown_base_height_m} m) cannot be "
                    f"higher than tree height: {self.height_m} m"
                )
            )

        if self.stump_height_m is not None and self.stump_height_m < 0:
            raise ValueError(f"Stump height must be larger or equal to 0 m: {self.stump_height_m}")