sasktran2.constituent.VMRAltitudeAbsorber

sasktran2.constituent.VMRAltitudeAbsorber#

class sasktran2.constituent.VMRAltitudeAbsorber(optical_property: OpticalProperty, altitudes_m: array, vmr: array, out_of_bounds_mode: str = 'zero')[source]#

Bases: Constituent

An atmospheric constituent that is specified through volume mixing ratio (VMR) on an altitude grid. The altitude grid need not match the global atmospheric grid, in the case they are different the VMRs will be linearly interpolated to the atmospheric grid locations.

The constituent has an associated OpticalProperty that defines the absorption cross section as a function of wavelength.

Parameters:

  • optical_property (OpticalProperty) – An object that provides absorption cross sections as a function of wavelength

  • altitudes_m (np.array) – Altitudes in [m] that the VMR is specified on

  • vmr (np.array) – Volume mixing ratio

  • out_of_bounds_mode (str, optional) – One of [‘zero’, ‘extend’], ‘zero’ will set the VMR to be 0 on any altitudes that are out of bounds. ‘extend’ will extend the last or first VMR value. By default ‘zero’

__init__(optical_property: OpticalProperty, altitudes_m: array, vmr: array, out_of_bounds_mode: str = 'zero') → None[source]#

An atmospheric constituent that is specified through volume mixing ratio (VMR) on an altitude grid. The altitude grid need not match the global atmospheric grid, in the case they are different the VMRs will be linearly interpolated to the atmospheric grid locations.

The constituent has an associated OpticalProperty that defines the absorption cross section as a function of wavelength.

Parameters:

  • optical_property (OpticalProperty) – An object that provides absorption cross sections as a function of wavelength

  • altitudes_m (np.array) – Altitudes in [m] that the VMR is specified on

  • vmr (np.array) – Volume mixing ratio

  • out_of_bounds_mode (str, optional) – One of [‘zero’, ‘extend’], ‘zero’ will set the VMR to be 0 on any altitudes that are out of bounds. ‘extend’ will extend the last or first VMR value. By default ‘zero’

Methods

__init__(optical_property, altitudes_m, vmr)

An atmospheric constituent that is specified through volume mixing ratio (VMR) on an altitude grid.

add_to_atmosphere(atmo)

register_derivative(atmo, name)

Attributes

altitudes_m

vmr