sasktran2.constituent.GaussianHeightExtinction

sasktran2.constituent.GaussianHeightExtinction#

class sasktran2.constituent.GaussianHeightExtinction(optical_property: OpticalProperty, height_m: float, width_fwhm_m: float, vertical_optical_depth: float, vertical_optical_depth_wavel_nm: float, altitudes_m: array, out_of_bounds_mode: str = 'zero', **kwargs)[source]#

Bases: Constituent

A constituent that is defined by a gaussian-shaped extinction profile.

Parameters:

  • optical_property (OpticalProperty) – The optical property defining the scattering information

  • height_m (float) – Height of the centre of the gaussian extinction profile in [m]

  • width_fwhm_m (float) – FWHM of the gaussian extinction profile in [m]

  • vertical_optical_depth (float) – Vertical optical depth

  • vertical_optical_depth_wavel_nm – Wavelength that the vertical optical depth is specified at

  • altitudes_m (np.array) – The altitude grid in [m] over which the optical depth is calculated, as well as the grid for any optical property arguments passed in through kwargs.

  • out_of_bounds_mode (str, optional) – Interpolation mode for outside of the boundaries of the altitude grid, “extend” and “zero” are supported, by default “zero”

  • kwargs (dict) – Additional arguments to pass to the optical property.

__init__(optical_property: OpticalProperty, height_m: float, width_fwhm_m: float, vertical_optical_depth: float, vertical_optical_depth_wavel_nm: float, altitudes_m: array, out_of_bounds_mode: str = 'zero', **kwargs) → None[source]#

A constituent that is defined by a gaussian-shaped extinction profile.

Parameters:

  • optical_property (OpticalProperty) – The optical property defining the scattering information

  • height_m (float) – Height of the centre of the gaussian extinction profile in [m]

  • width_fwhm_m (float) – FWHM of the gaussian extinction profile in [m]

  • vertical_optical_depth (float) – Vertical optical depth

  • vertical_optical_depth_wavel_nm – Wavelength that the vertical optical depth is specified at

  • altitudes_m (np.array) – The altitude grid in [m] over which the optical depth is calculated, as well as the grid for any optical property arguments passed in through kwargs.

  • out_of_bounds_mode (str, optional) – Interpolation mode for outside of the boundaries of the altitude grid, “extend” and “zero” are supported, by default “zero”

  • kwargs (dict) – Additional arguments to pass to the optical property.

Methods

__init__(optical_property, height_m, ...[, ...])

A constituent that is defined by a gaussian-shaped extinction profile.

add_to_atmosphere(atmo)

register_derivative(atmo, name)

Attributes

height_m

vertical_optical_depth

width_fwhm_m