eradiate.radprops.RadProfile

eradiate.radprops.RadProfile#

class eradiate.radprops.RadProfile[source]#

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.

eval_albedo(si, zgrid=None)[source]#
eval_albedo(si, zgrid)
eval_albedo(si, zgrid)

Evaluate albedo at given spectral index.

Parameters:

  • si (SpectralIndex) – Spectral index.

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

eval_dataset(si, zgrid=None)[source]#
eval_dataset(si, zgrid)
eval_dataset(si, zgrid)

Evaluate radiative properties at given spectral index.

Parameters:

  • si (SpectralIndex) – Spectral index.

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

eval_sigma_a(si, zgrid=None)[source]#
eval_sigma_a(si, zgrid)
eval_sigma_a(si, zgrid)

Evaluate absorption coefficient at given spectral index.

Parameters:

  • si (SpectralIndex) – Spectral index.

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

eval_sigma_a_ckd(w, g, zgrid)[source]#

Evaluate absorption coefficient spectrum in CKD modes.

eval_sigma_a_mono(w, zgrid)[source]#

Evaluate absorption coefficient spectrum in monochromatic mode.

eval_sigma_s(si, zgrid=None)[source]#
eval_sigma_s(si, zgrid)
eval_sigma_s(si, zgrid)

Evaluate scattering coefficient at given spectral index.

Parameters:

  • si (SpectralIndex) – Spectral index.

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

eval_sigma_t(si, zgrid=None)[source]#
eval_sigma_t(si, zgrid)
eval_sigma_t(si, zgrid)

Evaluate extinction coefficient at given spectral index.

Parameters:

  • si (SpectralIndex) – Spectral index.

  • 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 property zgrid#

Default altitude grid used for profile evaluation.

Contents