eradiate.scenes.measure.RadiancemeterMeasure
eradiate.scenes.measure.RadiancemeterMeasure#
- class eradiate.scenes.measure.RadiancemeterMeasure(id='measure', spectral_cfg=_Nothing.NOTHING, spp=1000, split_spp=None, origin=<Quantity([0. 0. 0.], 'meter')>, target=<Quantity([0. 0. 1.], 'meter')>)[source]#
Bases:
eradiate.scenes.measure._core.Measure
Radiance meter measure scene element [
radiancemeter
].This measure scene element is a thin wrapper around the
radiancemeter
sensor kernel plugin. It records the incident power per unit area per unit solid angle along a certain ray.- Parameters
id (
str
, optional, default:"measure"
) – User-defined object identifier.spectral_cfg (
MeasureSpectralConfig
ordict
, default:MeasureSpectralConfig.new()
) – Spectral configuration of the measure. Must match the current operational mode. Can be passed as a dictionary, which will be interpreted byMeasureSpectralConfig.from_dict()
.spp (
int
, default:1000
) – Number of samples per pixel.split_spp (
int
, optional) – If set, this measure will be split into multiple sensors, each with a sample count lower or equal to split_spp. This parameter should be used in single-precision modes when the sample count is higher than 100,000 (very high sample count might result in floating point number precision issues otherwise).origin (array-like, default:
[0
,0
,0] m
) – A 3-element vector specifying the position of the radiance meter.Unit-enabled field (default: ucc[‘length’]).
target (array-like, default:
[0
,0
,1] m
) – A 3-element vector specifying the location targeted by the sensor.Unit-enabled field (default: ucc[‘length’]).
- Fields
spectral_cfg (
MeasureSpectralConfig
) – Spectral configuration of the measure.spp (
int
) – Number of samples per pixel.split_spp (
int
) – If set, this measure will be split into multiple sensors, each with a sample count lower or equal to split_spp.origin (
quantity
) – A 3-element vector specifying the position of the radiance meter.target (
quantity
) – A 3-element vector specifying the location targeted by the sensor.
- is_distant()#
Return
True
iff measure records radiometric quantities at infinite distance.
- is_split()#
Return
True
iff sample count split shall be activated.
- kernel_dict(ctx)[source]#
Return a dictionary suitable for kernel scene configuration.
- Parameters
ctx (
KernelDictContext
) – A context data structure containing parameters relevant for kernel dictionary generation.- Returns
KernelDict
– Kernel dictionary which can be loaded as a Mitsuba object.
- property sensor_dims#
List of sensor dimension labels.
- Type
tuple of str