eradiate.radprops.AtmosphereRadProfile

eradiate.radprops.AtmosphereRadProfile#

class eradiate.radprops.AtmosphereRadProfile(absorption_data=NOTHING, thermoprops=NOTHING, has_absorption=True, has_scattering=True, *, rayleigh_depolarization=NOTHING)[source]#

Bases: RadProfile

Atmospheric radiative profile.

This class provides an interface to generate vertical profiles of atmospheric volume radiative properties (also sometimes referred to as collision coefficients).

The atmospheric radiative profile is built from a thermophysical profile, which provides the temperature, pressure and species concentrations as a function of altitude, and an absorption coefficient database indexed by those thermophysical variables.

Parameters:

  • absorption_data (str or path-like or dict or AbsorptionDatabase, default: AbsorptionDatabase.default()) – Absorption coefficient data. The passed value is pre-processed by AbsorptionDatabase.convert().

  • thermoprops (Dataset or path-like or dict) – Thermophysical property dataset. If a path is passed, Eradiate will look it up and load it. If a dictionary is passed, it will be passed as keyword argument to joseki.make(). The default is joseki.make(identifier="afgl_1986-us_standard",  z=np.linspace(0.0, 120.0, 121) * ureg.km). See the Joseki docs for details.

  • has_absorption (bool, default: True) – Absorption switch. If True, the absorption coefficient is computed. Else, the absorption coefficient is not computed and instead set to zero.

  • has_scattering (bool, default: True) – Scattering switch. If True, the scattering coefficient is computed. Else, the scattering coefficient is not computed and instead set to zero.

  • rayleigh_depolarization (array-like or str, optional, default: [0]) – Depolarization factor of the rayleigh phase function. str will be interpreted as the name of the function used to calculate the depolarization factor from atmospheric properties. A ndarray will be interpreted as a description of the depolarization factor at different levels of the atmosphere. Must be shaped (N,) with N the number of layers.

Fields:

  • absorption_data (AbsorptionDatabase) – Absorption coefficient data.

  • thermoprops (Dataset) – Thermophysical property dataset.

  • has_absorption (bool) – Absorption switch.

  • has_scattering (bool) – Scattering switch.

  • rayleigh_depolarization (ndarray or {"bates", "bodhaine"}) – Depolarization factor of the rayleigh phase function.

eval_albedo(si, zgrid=None)#

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

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_depolarization_factor(si, zgrid=None)#

Evaluate depolarization factor at given spectral index.

Parameters:

  • si (SpectralIndex) – Spectral index.

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

Returns:

quantity – Evaluated depolarization factor as an array with length equal to the number of layers if it is parametrized over layers, otherwise as an array of length 1.

eval_sigma_a(si, zgrid=None)#

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

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

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.

property zbounds#

Bounds of the z profile.

property zgrid#

Default altitude grid used for profile evaluation.

Contents