eradiate.scenes.measure.MultiRadiancemeterMeasure#

class eradiate.scenes.measure.MultiRadiancemeterMeasure(id='measure', srf=NOTHING, sampler='independent', rfilter='box', spp=1000, origins=<Quantity([[0. 0. 0.]], 'meter')>, directions=array([[0., 0., 1.]]))[source]#

Bases: Measure

Radiance meter array measure scene element [mradiancemeter, multi_radiancemeter].

This measure scene element is a thin wrapper around the mradiancemeter sensor kernel plugin. It records the incident power per unit area per unit solid angle along a number of rays defined by its origins and directions parameters.

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

  • srf (Path or str or Spectrum or dict, default: MultiDeltaSpectrum(wavelengths=550.0 * ureg.nm)) – Spectral response function (SRF). If a path is passed, it attempts to load a dataset from that location. If a keyword is passed, e.g., 'sentinel_2a-msi-4' it tries to serve the corresponding dataset from the Eradiate data store. By default, the prepared version of the SRF is served unless it does not exist in which case the raw version is served. To request that the raw version is served, append '-raw' to the keyword, e.g., 'sentinel_2a-msi-4-raw'. Note that the prepared SRF provide a better speed versus accuracy trade-off, but for the best accuracy, the raw SRF should be used. Other types will be converted by spectrum_factory.

  • sampler ({"independent", "stratified", "multijitter", "orthogonal", "ldsampler"}, default: "independent") – Mitsuba sampler used to generate pseudo-random number sequences.

  • rfilter ({"box", "gaussian"}, default: "box") – Reconstruction filter used to scatter samples on sensor pixels. By default, using a box filter is recommended.

  • spp (int, default: 1000) – Number of samples per pixel.

  • origins (array-like, default: [[0, 0, 0]] m) – A sequence of points specifying radiance meter array positions.

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

  • directions (array-like, default: [[0, 0, 1]]) – A sequence of 3-vectors specifying radiance meter array directions.

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

  • srf (Spectrum) – Spectral response function (SRF).

  • sampler (str) – Mitsuba sampler used to generate pseudo-random number sequences.

  • rfilter (str) – Reconstruction filter used to scatter samples on sensor pixels.

  • spp (int) – Number of samples per pixel.

  • origins (quantity) – A sequence of points specifying radiance meter array positions.

  • directions (quantity) – A sequence of 3-vectors specifying radiance meter array directions.

is_distant()#

Return True iff measure records radiometric quantities at infinite distance.

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 film_resolution#

Getter for film resolution as a (int, int) pair.

Type:

tuple

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.

property var#

Post-processing variable field name and metadata.

Type:

str, dict