eradiate.scenes.phase.PhaseFunction#

class eradiate.scenes.phase.PhaseFunction(id='phase')[source]#

Bases: eradiate.scenes.core.SceneElement, abc.ABC

An abstract base class defining common facilities for all phase functions.

Parameters

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

Fields

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

abstract kernel_dict(ctx)#

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.