eradiate.scenes.biosphere._leaf_cloud.CuboidLeafCloudParams

eradiate.scenes.biosphere._leaf_cloud.CuboidLeafCloudParams#

class eradiate.scenes.biosphere._leaf_cloud.CuboidLeafCloudParams(id='leaf_cloud', leaf_reflectance=0.5, leaf_transmittance=0.5, mu=1.066, nu=1.853, n_leaves=None, leaf_radius=None, l_horizontal=None, l_vertical=None, lai=None, hdo=None, hvr=None)[source]#

Bases: LeafCloudParams

Advanced parameter checking class for the cuboid LeafCloud generator. Some of the parameters can be inferred from each other.

Parameters defined below can be used (without leading underscore) as keyword arguments to the LeafCloud.cuboid() class method constructor. Parameters without defaults are connected by a dependency graph used to compute required parameters (outlined in the figure below).

The following parameter sets are valid:

  • n_leaves, leaf_radius, l_horizontal, l_vertical;

  • lai, leaf_radius, l_horizontal, l_vertical;

  • lai, leaf_radius, l_horizontal, hdo, hvr;

  • and more!

../../../../_images/cuboid_leaf_cloud_params.svg
Parameters:
  • id (str, default: "leaf_cloud") – Leaf cloud identifier.

  • leaf_reflectance (float, default: 0.5) – Leaf reflectance.

  • leaf_transmittance (float, default: 0.5) – Leaf transmittance.

  • mu (float, default: 1.066) – First parameter of the inverse beta distribution approximation used to generate leaf orientations.

  • nu (float, default: 1.853) – Second parameter of the inverse beta distribution approximation used to generate leaf orientations.

  • n_leaves (int) – Number of leaves.

  • leaf_radius (float) – Leaf radius.

    Unit-enabled field (default: ucc[‘length’]).

  • l_horizontal (float) – Leaf cloud horizontal extent. Suggested default: 30 m.

    Unit-enabled field (default: ucc[‘length’]).

  • l_vertical (float) – Leaf cloud vertical extent. Suggested default: 3 m.

    Unit-enabled field (default: ucc[‘length’]).

  • lai (float) – Leaf cloud leaf area index (LAI). Physical range: [0, 10]; suggested default: 3.

    Unit-enabled field (default: ucc[‘dimensionless’]).

  • hdo (float) – Mean horizontal distance between leaves.

    Unit-enabled field (default: ucc[‘length’]).

  • hvr (float) – Ratio of mean horizontal leaf distance and vertical leaf cloud extent. Suggested default: 0.1.

Warning

In case of over-specification, no consistency check is performed.