eradiate.scenes.spectra.Spectrum#
- class eradiate.scenes.spectra.Spectrum(id=None, quantity='dimensionless')[source]#
Bases:
NodeSceneElement
,ABC
Spectrum interface.
- Parameters:
id (
str
, optional) – Identifier of the current scene element.quantity (
PhysicalQuantity
orstr
, default:dimensionless
) – Physical quantity which the spectrum represents. The specified quantity must be one which varies with wavelength. SeePhysicalQuantity.spectrum()
for allowed values.Child classes should implement value units validation and conversion based on
quantity
.
- Fields:
quantity (
PhysicalQuantity
) – Physical quantity which the spectrum represents.
Notes
This class is to be used as a mixin.
Subclasses must implement
eval_mono()
,eval_ckd()
andintegral()
.
- eval(spectral_ctx)[source]#
Evaluate spectrum based on a spectral context. This method dispatches evaluation to specialized methods depending on the active mode.
- Parameters:
spectral_ctx (
SpectralContext
) – A spectral context data structure containing relevant spectral parameters (e.g. wavelength in monochromatic mode, bin and quadrature point index in CKD mode).- Returns:
value (
quantity
) – Evaluated spectrum as a scalar.
- 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 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
,UpdateParameter
] orNone
– A dictionary mapping parameter paths, consisting of dot-separated strings, to a corresponding update protocol.
See also
- abstract property template#
Kernel dictionary template contents associated with this scene element.
- Returns:
dict
– A flat dictionary mapping dot-separated strings describing the path of an item in the nested scene dictionary to values. Values may be objects which can be directly used by themitsuba.load_dict()
function, orInitParameter
instances which must be rendered.
See also