eradiate.kernel

Go to Mitsuba 3 docs

Mitsuba scene templating

DictParameter(func)

This class declares an Eradiate parameter in a Mitsuba scene dictionary.

KernelDict([data])

A dict-like structure which defines the structure of an instantiable Mitsuba scene dictionary.

SceneParameter(func[, flags, search, ...])

This class declares an Eradiate parameter in a Mitsuba scene parameter map.

SearchSceneParameter(node_type, node_id, ...)

This class defines a scene parameter search protocol applied during the Mitsuba scene tree traversal.

KernelSceneParameterMap([data])

A dict-like structure which contains the structure of a Mitsuba scene parameter update map.

KernelSceneParameterFlags(value)

A set of flags characterizing the various parameters present in an Eradiate scene.

dict_parameter([maybe_fn])

This function wraps another one into a DictParameter instance.

scene_parameter([maybe_fn, flags])

This function wraps another one into a SceneParameter instance.

Mitsuba scene initialization, traversal and rendering

MitsubaObjectWrapper(obj[, parameters, ...])

This container aggregates a Mitsuba object, its associated parameters and a set of updaters that can be used to modify the scene parameters.

mi_load_dict(dict[, parallel, optimize])

Load a Mitsuba scene or object from a Python dictionary.

mi_traverse(obj[, umap_template, ...])

Traverse a node of the Mitsuba scene graph and return a container holding the Mitsuba scene, its parameter map and an updated parameter update map.

mi_render(mi_scene, ctxs[, spp, seed_state])

Render a Mitsuba scene multiple times given specified contexts and sensor indices.

Other helpers

bitmap_to_dataarray(bmp[, dtype])

Format Mitsuba bitmap data as an xarray data array.

bitmap_to_dataset(bmp[, dtype])

Format Mitsuba bitmap data as an xarray dataset.

eval_bsdf(plugin, theta_os, phi_os, ...)

map_cube(xmin, xmax, ymin, ymax, zmin, zmax)

Map the cube \([-1, 1]^3\) to \([x_\mathrm{min}, x_\mathrm{max}] \times [y_\mathrm{min}, y_\mathrm{max}] \times [z_\mathrm{min}, z_\mathrm{max}]\).

map_unit_cube(xmin, xmax, ymin, ymax, zmin, zmax)

Map the unit cube \([0, 1]^3\) to \([x_\mathrm{min}, x_\mathrm{max}] \times [y_\mathrm{min}, y_\mathrm{max}] \times [z_\mathrm{min}, z_\mathrm{max}]\).

read_binary_grid3d(filename)

Reads a volume data binary file.

write_binary_grid3d(filename, values)

Write volume data to a binary file so that a gridvolume kernel plugin can be instantiated with that file.