eradiate.spectral.MonoSpectralIndex¶

class eradiate.spectral.MonoSpectralIndex(w=<Quantity(550.0, 'nanometer')>)[source]¶

Bases: SpectralIndex

Monochromatic spectral index.

Parameters:

w (quantity or float, default: 550.0 nm) – Wavelength.

Unit-enabled field (default: ucc[wavelength]).

Fields:

w (quantity) – Wavelength.

See also

CKDSpectralIndex

static new(mode=None, **kwargs)¶

Spectral index factory method.

Parameters:: mode (.ModeFlag or str, optional) – Spectral mode identifier. If None, the current mode is used.
Returns:: SpectralIndex – Spectral index instance.

Notes

Create a new instance of the spectral index class corresponding to the specified mode.

See also

MonoSpectralIndex, CKDSpectralIndex

property as_hashable¶

Hashable representation of the spectral index.

Notes

The hashable value is used by eradiate.experiments.Experiment to identify the simulation results corresponding to a given spectral index.

property formatted_repr¶: Formatted representation of the spectral index.