eradiate.scenes.measure.MultiPixelDistantMeasure¶

class eradiate.scenes.measure.MultiPixelDistantMeasure(id='measure', srf=NOTHING, sampler='independent', rfilter='box', spp=1000, target=None, ray_offset=None, azimuth_convention=None, direction=[0, 0, 1], film_resolution=(32, 32))[source]¶

Bases: AbstractDistantMeasure

Multi-pixel distant measure scene element [mpdistant, multipixel_distant]

This scene element records radiance leaving the scene in a single direction defined by its direction parameter. Most users will however find the MultiDistantMeasure class more flexible.

Parameters:

id (str, optional, default: "measure") – Identifier of the current scene element.
srf (path-like or str or SpectralResponseFunction or dict, default: DeltaSRF(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', the corresponding dataset is looked up through the file resolver.
sampler ({"independent", "stratified", "multijitter", "orthogonal", "ldsampler"}, default: "independent") – Mitsuba sampler used to generate pseudo-random number sequences.
rfilter ({"box", "gaussian", "tent", "mitchell", "catmullrom", "lanczos"}, 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.
target (Target or dict or array-like, optional) – Target specification. The target can be specified using an array-like with 3 elements (which will be converted to a TargetPoint) or a dictionary interpreted by Target.convert(). If set to None (not recommended), the default target point selection method is used: rays will not target a particular region of the scene.
ray_offset (float or quantity, optional, default: None) – Manually control the distance between the target and ray origins. If unset, ray origins are positioned outside of the scene and this measure is rigorously distant.
azimuth_convention (AzimuthConvention or str, optional, default: None) – Azimuth convention. If None, the global default configuration is used (see Configuration).
direction (array-like, default: [0, 0, 1]) – A 3-vector defining the direction observed by the sensor, pointing outwards the target.
film_resolution (array-like, default: (32, 32)) – Film resolution as a (width, height) 2-tuple.

Fields:

id (str or None) – Identifier of the current scene element.
srf (SpectralResponseFunction) – 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.
target (Target or None) – Target specification.
ray_offset (quantity or None) – Manually control the distance between the target and ray origins.
azimuth_convention (AzimuthConvention) – Azimuth convention.
direction (ndarray) – A 3-vector defining the direction observed by the sensor, pointing outwards the target.

classmethod from_angles(angles, **kwargs)[source]¶

Construct using a direction layout defined by explicit (zenith, azimuth) pairs.

Parameters:

angles (array-like) – A (zenith, azimuth) pair, either as a quantity or a unitless array-like. In the latter case, the default angle units are applied.
azimuth_convention (AzimuthConvention or str, optional) – The azimuth convention applying to the viewing direction layout. If unset, the global default convention is used.
**kwargs – Remaining keyword arguments are forwarded to the DistantMeasure constructor.

Returns:

DistantMeasure

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, SceneParameter] or None – A dictionary mapping parameter paths, consisting of dot-separated strings, to a corresponding update protocol.