eradiate.scenes.bsdfs.RTLSBSDF#

class eradiate.scenes.bsdfs.RTLSBSDF(id=None, f_iso=0.209741, f_vol=0.00414, f_geo=0.081384, h=2.0, r=1.0, b=1.0)[source]#

Bases: BSDF

RTLS BSDF [rtls].

This class implements the RossThick-LiSparse (RTLS) BRDF as described by the MODIS BRDF/Albedo Product ATBD [Strahler et al., 1999].

Parameters:
  • id (str, optional) – Identifier of the current scene element.

  • f_iso (Spectrum or dict or float, optional, default: 0.209741) – Isotropic scattering kernel parameter. Defaults to \(f_{iso} = 0.209741\).

  • f_vol (Spectrum or dict or float, optional, default: 0.004140) – Volumetric scattering from horizontally homogeneous leaf canopies kernel parameter. Defaults to \(f_{vol} = 0.004140\).

  • f_geo (float, optional, default: 0.081384) – Geometric-optical surface scattering kernel parameter. Defaults to \(f_{geo} = 0.081384\).

  • h (quantity or float, default: 2.0) – Height-to-center-of-crown. Must be dimensionless.

  • r (quantity or float, default: 1.0) – Crown horizontal radius. Must not be zero.

  • b (quantity or float, default: 1.0) – Crown vertical radius. Must not be zero.

Fields:
  • id (str or None) – Identifier of the current scene element.

  • f_iso (Spectrum) – Isotropic scattering kernel parameter.

  • f_vol (Spectrum) – Volumetric scattering from horizontally homogeneous leaf canopies kernel parameter.

  • f_geo (float) – Geometric-optical surface scattering kernel parameter.

  • h (quantity) – Height-to-center-of-crown.

  • r (quantity) – Crown horizontal radius.

  • b (quantity) – Crown vertical radius.

traverse(callback)#

Traverse this scene element and collect kernel dictionary template and parameter update map contributions.

Parameters:

callback (SceneTraversal) – Callback data structure storing the collected data.

update()#

Enforce internal state consistency. This method should be called when fields are modified. It is automatically called as a post-init step.

property objects#

Map of child objects associated with this scene element.

Returns:

dict – A dictionary mapping object names to a corresponding object to be inserted in the Eradiate scene graph.

property params#
Returns:

dict[str, UpdateParameter] or None – A dictionary mapping parameter paths, consisting of dot-separated strings, to a corresponding update protocol.

property template#

Kernel dictionary template contents associated with this scene element.

Returns:

dict – A flat dictionary mapping dot-separated strings describing the path of an item in the nested scene dictionary to values. Values may be objects which can be directly used by the mitsuba.load_dict() function, or InitParameter instances which must be rendered.