eradiate.radprops.RadProfile

class eradiate.radprops.RadProfile

Bases: 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.

See also

rad_profile_factory

eval_albedo(spectral_ctx, zgrid=None)

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

• zgrid (ZGrid, optional) – The altitude grid for which the albedo is evaluated. If unset, a profile-specific default is used.

Returns:

quantity – Evaluated spectrum as an array with length equal to the number of layers.

abstract eval_albedo_ckd(bindexes, zgrid)

Evaluate albedo spectrum in CKD modes.

Parameters:

• bindexes (list of Bindex) – CKD bindexes for which to evaluate the spectrum.

• zgrid (ZGrid) – The altitude grid for which the albedo is evaluated.

Returns:

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

abstract eval_albedo_mono(w, zgrid)

Evaluate albedo spectrum in monochromatic modes.

Parameters:

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

• zgrid (ZGrid) – The altitude grid for which the albedo is evaluated.

Returns:

quantity – Evaluated profile albedo as an array with shape (n_layers, len(w)).

eval_dataset(spectral_ctx, zgrid=None)

Return a dataset that holds the radiative properties of the corresponding atmospheric profile. This method dispatches evaluation to specialized 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).

• zgrid (ZGrid, optional) – The altitude grid for which the radiative profile is evaluated. If unset, a profile-specific default is used.

Returns:

Dataset – Radiative property dataset.

abstract eval_dataset_ckd(bindexes, zgrid)

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

Parameters:

• bindexes (list of Bindex) – One or several CKD bindexes for which to evaluate spectra.

• zgrid (ZGrid) – The altitude grid for which the radiative profile is evaluated.

Returns:

Dataset – Radiative property dataset.

abstract eval_dataset_mono(w, zgrid)

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.

• zgrid (ZGrid) – The altitude grid for which the radiative profile is evaluated.

Returns:

Dataset – Radiative property dataset.

eval_sigma_a(spectral_ctx, zgrid=None)

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

• zgrid (ZGrid, optional) – The altitude grid for which the absorption coefficient is evaluated. If unset, a profile-specific default is used.

Returns:

quantity – Evaluated spectrum as an array with length equal to the number of layers.

abstract eval_sigma_a_ckd(bindexes, zgrid)

Evaluate absorption coefficient spectrum in CKD modes.

Parameters:

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

• zgrid (ZGrid) – The altitude grid for which the extinction coefficient is evaluated.

Returns:

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

abstract eval_sigma_a_mono(w, zgrid)

Evaluate absorption coefficient spectrum in monochromatic modes.

Parameters:

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

• zgrid (ZGrid) – The altitude grid for which the extinction coefficient is evaluated.

Returns:

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

eval_sigma_s(spectral_ctx, zgrid=None)

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

• zgrid (ZGrid, optional) – The altitude grid for which the scattering coefficient is evaluated. If unset, a profile-specific default is used.

Returns:

quantity – Evaluated spectrum as an array with length equal to the number of layers.

abstract eval_sigma_s_ckd(bindexes, zgrid)

Evaluate scattering coefficient spectrum in CKD modes.

Parameters:

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

• zgrid (ZGrid) – The altitude grid for which the scattering coefficient is evaluated.

Returns:

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

abstract eval_sigma_s_mono(w, zgrid)

Evaluate scattering coefficient spectrum in monochromatic modes.

Parameters:

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

• zgrid (ZGrid) – The altitude grid for which the scattering coefficient is evaluated.

Returns:

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

eval_sigma_t(spectral_ctx, zgrid=None)

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

• zgrid (ZGrid, optional) – The altitude grid for which the extinction coefficient is evaluated. If unset, a profile-specific default is used.

Returns:

quantity – Evaluated spectrum as an array with length equal to the number of layers.

abstract eval_sigma_t_ckd(bindexes, zgrid)

Evaluate extinction coefficient spectrum in CKD modes.

Parameters:

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

• zgrid (ZGrid) – The altitude grid for which the extinction coefficient is evaluated.

Returns:

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

abstract eval_sigma_t_mono(w, zgrid)

Evaluate extinction coefficient spectrum in monochromatic modes.

Parameters:

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

• zgrid (ZGrid) – The altitude grid for which the extinction coefficient is evaluated.

Returns:

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

abstract property zgrid

Default altitude grid used for profile evaluation.