- class eradiate.scenes.spectra.Spectrum(id=None, quantity=None)#
str, optional) – Identifier of the current scene element.
str, optional, default:
None) – Physical quantity which the spectrum represents. The specified quantity must be one which varies with wavelength. See
PhysicalQuantity.spectrum()for allowed values.
Child classes should implement value units validation and conversion based on
quantityfield unset is discouraged and permitted only to allow for more convenience in some parts of the code (e.g. to increase the flexibility of spectrum conversion protocols).
Evaluate spectrum at a given spectral index.
This method dispatches evaluation to specialized methods depending on the spectral index type.
- abstract eval_ckd(w, g)#
Evaluate spectrum in CKD modes.
quantity) – Evaluated spectrum as an array with shape
It is assumed that
ghave the same shape. In CKD mode, it is assumed that all spectra—except that of the absorption coefficient—are uniform over the spectral bin. These spectra are evaluated at the spectral bin center wavelength.
- abstract eval_mono(w)#
Evaluate spectrum in monochromatic modes.
- integral(wmin, wmax)#
Compute the integral of the spectrum on a given interval.
quantityfield is unset (i.e. left to its default value
None), the output of this method will inherit the units of value fields (the actual policy depends on the implementation, and unitless values are intepreted as dimnesionless). Note that leaving the
quantityfield unset is discouraged.
Select a subset of a spectral set.
This method is only relevant to subclasses used to represent spectral response function (the default implementation raises a
NotImplementedError). In this context, the spectral response function acts as a sort of filter that selects a subset of a spectral set, e.g. where the response is non-zero. This method is useful for
Experimentobjects to determine which spectral set is relevant for a given sensor.
Traverse this scene element and collect kernel dictionary template and parameter update map contributions.
SceneTraversal) – Callback data structure storing the collected data.
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.
dict– A dictionary mapping object names to a corresponding object to be inserted in the Eradiate scene graph.
- property params#
- abstract property template#
Kernel dictionary template contents associated with this scene element.