eradiate.scenes.spectra.AirScatteringCoefficientSpectrum#

class eradiate.scenes.spectra.AirScatteringCoefficientSpectrum(id=None)[source]#

Bases: eradiate.scenes.spectra._core.Spectrum

Air scattering coefficient spectrum [air_scattering_coefficient].

Parameters

id (str, optional, default: None) – User-defined object identifier.

Fields

id (str or None) – User-defined object identifier.

See also

compute_sigma_s_air()

Notes

Evaluation is as follows:

  • in mono_* modes, the spectrum is evaluated at the spectral context wavelength;

  • in ckd_* modes, the spectrum is evaluated as the average value over the spectral context bin (the integral is computed using a trapezoid rule).

eval(spectral_ctx)#

Evaluate spectrum based on a spectral context. This method dispatches evaluation to specialised 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.

eval_ckd(*bindexes)[source]#

Evaluate spectrum in CKD modes.

Parameters

*bindexes (Bindex) – One or several CKD bindexes for which to evaluate the spectrum.

Returns

value (quantity) – Evaluated spectrum as an array with shape (len(bindexes),).

eval_mono(w)[source]#

Evaluate spectrum in monochromatic modes.

Parameters

w (quantity) – Wavelength values at which the spectrum is to be evaluated.

Returns

value (quantity) – Evaluated spectrum as an array with the same shape as w.

integral(wmin, wmax)[source]#

Compute the integral of the spectrum on a given interval.

Parameters

  • wmin (quantity) – Integration interval’s lower bound.

  • wmax (quantity) – Integration interval’s upper bound.

Returns

value (quantity) – Computed integral value.

kernel_dict(ctx)[source]#

Return a dictionary suitable for kernel scene configuration.

Parameters

ctx (KernelDictContext) – A context data structure containing parameters relevant for kernel dictionary generation.

Returns

KernelDict – Kernel dictionary which can be loaded as a Mitsuba object.