eradiate.scenes.integrators.VolPathIntegrator#

class eradiate.scenes.integrators.VolPathIntegrator(id='integrator', max_depth=None, rr_depth=None, hide_emitters=None)[source]#

Bases: eradiate.scenes.integrators._path_tracers.MonteCarloIntegrator

A thin interface to the volumetric path tracer kernel plugin.

This integrator samples paths using random walks starting from the sensor. It supports multiple scattering and accounts for volume interactions.

Parameters

  • id (str, optional, default: "integrator") – User-defined object identifier.

  • max_depth (int, optional) – Longest path depth in the generated measure data (where -1 corresponds to ∞). A value of 1 will display only visible emitters. 2 computes only direct illumination (no multiple scattering), etc. If unset, the kernel default value (-1) is used.

  • rr_depth (int, optional) – Minimum path depth after which the implementation starts applying the Russian roulette path termination criterion. If unset, the kernel default value (5) is used.

  • hide_emitters (bool, optional) – Hide directly visible emitters. If unset, the kernel default value (false) is used.

Fields

  • id (str or None) – User-defined object identifier.

  • max_depth (int, optional) – Longest path depth in the generated measure data (where -1 corresponds to ∞).

  • rr_depth (int, optional) – Minimum path depth after which the implementation starts applying the Russian roulette path termination criterion.

  • hide_emitters (bool, optional) – Hide directly visible emitters.

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.