eradiate.spectral.SpectralIndex¶

class eradiate.spectral.SpectralIndex[source]¶

Bases: ABC

Abstract spectral index base class.

See also

MonoSpectralIndex, CKDSpectralIndex

static new(mode=None, **kwargs)[source]¶

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

abstract 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.

abstract property formatted_repr¶: Formatted representation of the spectral index.