eradiate.scenes.bsdfs.OceanLegacyBSDF

eradiate.scenes.bsdfs.OceanLegacyBSDF#

class eradiate.scenes.bsdfs.OceanLegacyBSDF(id=None, wind_speed=NOTHING, wind_direction=NOTHING, chlorinity=NOTHING, pigmentation=NOTHING, shadowing=True)[source]#

Bases: BSDF

Ocean Legacy BSDF [ocean_legacy].

This BSDF implements the 6SV ocean surface model as described in Kotchenova et al. [2006]. This model treats the ocean as an opaque surface, and models the sunglint, whitecap and underlight components of the ocean reflectance. It depends on wind properties and pigmentation and chlorinity which makes it suitable to represent case I waters as defined by Morel [1988].

Parameters:

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

  • wind_speed (quantity or float, default: 0.01 m/s) – Wind speed [m/s] at 10 meters above the surface.

  • wind_direction (quantity or float, default: 0.0 deg) – Wind azimuthal angle in North Left-Hand convention.

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

  • chlorinity (quantity or float, default: 19.0 g/kg) – Chlorinity of water.

  • pigmentation (quantity or float, default: 0.3 mg/m^3) – Pigmentation of water.

  • shadowing (bool, default: True) – Indicates whether evaluation of BRDF computes shadowing and masking.

Fields:

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

  • wind_speed (quantity) – Wind speed [m/s] at 10 meters above the surface.

  • wind_direction (quantity) – Wind azimuthal angle in North Left-Hand convention.

  • chlorinity (quantity) – Chlorinity of water.

  • pigmentation (quantity) – Pigmentation of water.

  • shadowing (bool) – Indicates whether evaluation of BRDF computes shadowing and masking.

See also

(Legacy 6S) Oceanic reflection model (ocean-legacy)

Notes

The wind_direction parameter indicates the azimuth angle of the wind and is interpreted using the North left convention.

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.

See also

UpdateParameter, UpdateMapTemplate

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.

See also

InitParameter, KernelDictTemplate

Contents