eradiate.scenes.measure.Measure#
- class eradiate.scenes.measure.Measure(id='measure', srf=_Nothing.NOTHING, sampler='independent', rfilter='box', spp=1000)[source]#
Bases:
NodeSceneElement
,ABC
Abstract base class for all measure scene elements.
- Parameters:
id (
str
, optional, default:"measure"
) – Identifier of the current scene element.srf (
Path
orstr
orSpectrum
ordict
, 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 byspectrum_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.
- Fields:
See also
mitsuba_run()
Notes
This class is meant to be used as a mixin.
Raw results stored in the results field as nested dictionaries with the following structure:
{ spectral_key_0: dict_0, spectral_key_1: dict_1, ... }
Keys are spectral loop indexes; values are nested dictionaries produced by
mitsuba_run()
.
- 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
] orNone
– A dictionary mapping parameter paths, consisting of dot-separated strings, to a corresponding update protocol.
See also
- 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 themitsuba.load_dict()
function, orInitParameter
instances which must be rendered.
See also