eradiate.radprops.ArrayRadProfile#

class eradiate.radprops.ArrayRadProfile(levels, albedo_values, sigma_t_values)[source]#

Bases: eradiate.radprops._core.RadProfile

A flexible 1D radiative property profile whose level altitudes, albedo and extinction coefficient are specified as numpy arrays.

Parameters

levels (array) – Level altitudes. Required, no default.

Unit-enabled field (default: ucc[‘length’]).
albedo_values (array) – An array specifying albedo values. Required, no default.

Unit-enabled field (dimensionless).
sigma_t_values (array) – An array specifying extinction coefficient values. Required, no default.

Unit-enabled field (default: ucc[‘collision_coefficient’]).

Fields

levels (array) – Level altitudes.
albedo_values (array) – An array specifying albedo values.
sigma_t_values (array) – An array specifying extinction coefficient values.

eval_albedo(spectral_ctx)#

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)#

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)#

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)#

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)#

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)#

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)#

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)#

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)#

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)#

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