eradiate.radprops.RadProfile#

class eradiate.radprops.RadProfile[source]#

Bases: abc.ABC

An abstract base class for radiative property profiles. Classes deriving from this one must implement methods which return the albedo and collision coefficients as Pint-wrapped Numpy arrays.

Warning

Arrays returned by the albedo(), sigma_a(), sigma_s() and sigma_t() methods must be 3D. Should the profile be one-dimensional, invariant dimensions can be set to 1.

See also

RadProfileFactory

eval_albedo(spectral_ctx)[source]#

Evaluate albedo 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: quantity – Evaluated spectrum as an array with length equal to the number of layers.

eval_albedo_ckd(*bindexes)[source]#

Evaluate albedo spectrum in CKD modes.

Parameters: *bindexes (Bindex) – One or several CKD bindexes for which to evaluate the spectrum.
Returns: quantity – Evaluated profile albedo as an array with shape (n_layers, len(bindexes)).

eval_albedo_mono(w)[source]#

Evaluate albedo spectrum in monochromatic modes.

Parameters: w (quantity) – Wavelength values at which the spectrum is to be evaluated.
Returns: quantity – Evaluated profile albedo as an array with shape (n_layers, len(w)).

eval_dataset(spectral_ctx)[source]#

Return a dataset that holds the radiative properties of the corresponding atmospheric profile. 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).
Returns: Dataset – Radiative properties dataset.

eval_dataset_ckd(*bindexes, bin_set_id)[source]#

Return a dataset that holds the radiative properties of the corresponding atmospheric profile in CKD modes

Parameters

*bindexes (Bindex) – One or several CKD bindexes for which to evaluate spectra.
bin_set_id (str) – CKD bin set identifier.

Returns

Dataset – Radiative properties dataset.

eval_dataset_mono(w)[source]#

Return a dataset that holds the radiative properties of the corresponding atmospheric profile in monochromatic modes.

Parameters: w (quantity) – Wavelength values at which spectra are to be evaluated.
Returns: Dataset – Radiative properties dataset.

eval_sigma_a(spectral_ctx)[source]#

Evaluate absorption coefficient 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: quantity – Evaluated spectrum as an array with length equal to the number of layers.

eval_sigma_a_ckd(*bindexes, bin_set_id)[source]#

Evaluate absorption coefficient spectrum in CKD modes.

Parameters

*bindexes (Bindex) – One or several CKD bindexes for which to evaluate the spectrum.
bin_set_id (str) – CKD bin set identifier.

Returns

quantity – Evaluated profile absorption coefficient as an array with shape (n_layers, len(bindexes)).

eval_sigma_a_mono(w)[source]#

Evaluate absorption coefficient spectrum in monochromatic modes.

Parameters: w (quantity) – Wavelength values at which the spectrum is to be evaluated.
Returns: quantity – Evaluated profile absorption coefficient as an array with shape (n_layers, len(w)).

eval_sigma_s(spectral_ctx)[source]#

Evaluate scattering coefficient 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: quantity – Evaluated spectrum as an array with length equal to the number of layers.

eval_sigma_s_ckd(*bindexes)[source]#

Evaluate scattering coefficient spectrum in CKD modes.

Parameters: *bindexes (Bindex) – One or several CKD bindexes for which to evaluate the spectrum.
Returns: quantity – Evaluated profile scattering coefficient as an array with shape (n_layers, len(bindexes)).

eval_sigma_s_mono(w)[source]#

Evaluate scattering coefficient spectrum in monochromatic modes.

Parameters: w (quantity) – Wavelength values at which the spectrum is to be evaluated.
Returns: quantity – Evaluated profile scattering coefficient as an array with shape (n_layers, len(w)).

eval_sigma_t(spectral_ctx)[source]#

Evaluate extinction coefficient 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: quantity – Evaluated spectrum as an array with length equal to the number of layers.

eval_sigma_t_ckd(*bindexes)[source]#

Evaluate extinction coefficient spectrum in CKD modes.

Parameters: *bindexes (Bindex) – One or several CKD bindexes for which to evaluate the spectrum.
Returns: quantity – Evaluated profile extinction coefficient as an array with shape (n_layers, len(bindexes)).

eval_sigma_t_mono(w)[source]#

Evaluate extinction coefficient spectrum in monochromatic modes.

Parameters: w (quantity) – Wavelength values at which the spectrum is to be evaluated.
Returns: quantity – Evaluated profile extinction coefficient as an array with shape (n_layers, len(w)).