Ctrl+K

eradiate.spectral.CKDSpectralIndex

eradiate.spectral.CKDSpectralIndex#

class eradiate.spectral.CKDSpectralIndex(w=<Quantity(550.0, 'nanometer')>, g=0.0)[source]#

Bases: SpectralIndex

CKD spectral index.

Parameters:

  • w (quantity or float, default: 550.0 nm) – Bin center wavelength.

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

  • g (float, default: 0.0) – g value.

Fields:

See also

MonoSpectralIndex

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

Spectral index factory method.

Parameters:

mode (SpectralMode 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.

Contents