eradiate.scenes.measure.HemisphericalDistantMeasure
eradiate.scenes.measure.HemisphericalDistantMeasure#
- class eradiate.scenes.measure.HemisphericalDistantMeasure(id='measure', spectral_cfg=_Nothing.NOTHING, spp=1000, split_spp=None, azimuth_convention=None, film_resolution=(32, 32), orientation=<Quantity(0.0, 'degree')>, direction=[0, 0, 1], target=None)[source]#
Bases:
eradiate.scenes.measure._core.Measure
Hemispherical distant radiance measure scene element [
hdistant
,hemispherical_distant
].This scene element records radiance leaving the scene in a hemisphere defined by its
direction
parameter. A distinctive feature of this measure is that it samples continuously the direction space instead of computing radiance values for a fixed set of directions, thus potentially capturing effects much harder to distinguish using e.g. theMultiDistantMeasure
class. On the other side, features located at a precise angle will not be captured very well by this measure.This measure is useful to get a global view of leaving radiance patterns over a surface.
- 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).azimuth_convention (
AzimuthConvention
orstr
, optional, default:None
) – Azimuth convention. IfNone
, the global default configuration is used (seeEradiateConfig
).film_resolution (array-like, default:
(32
,32)
) – Film resolution as a (width, height) 2-tuple. If the height is set to 1, direction sampling will be restricted to a plane.orientation (
float
, default:0.0 deg
) – Azimuth angle defining the orientation of the sensor in the horizontal plane.Unit-enabled field (default: ucc[‘angle’]).
direction (array-like, default:
[0
,0
,1]
) – A 3-vector orienting the hemisphere mapped by the measure.target (
Target
ordict
or array-like, optional) – Target specification. The target can be specified using an array-like with 3 elements (which will be converted to aTargetPoint
) or a dictionary interpreted byTarget.convert()
. If set toNone
(not recommended), the default target point selection method is used: rays will not target a particular region of the scene.
- 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.azimuth_convention (
AzimuthConvention
) – Azimuth convention.orientation (
float
) – Azimuth angle defining the orientation of the sensor in the horizontal plane.direction (array-like) – A 3-vector orienting the hemisphere mapped by the measure.
Notes
Setting the
target
parameter is required to get meaningful results. Experiment classes should take care of setting it appropriately.
- 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
- property viewing_angles#
Viewing angles computed from stored film coordinates as a (width, height, 2) array. The last dimension is ordered as (zenith, azimuth).
- Type
quantity