sasktran2.constituent.NumberDensityScatterer

sasktran2.constituent.NumberDensityScatterer#

class sasktran2.constituent.NumberDensityScatterer(optical_property: OpticalProperty, altitudes_m: array, number_density: array, out_of_bounds_mode: str = 'zero', **kwargs)[source]#

Bases: Constituent

A scattering constituent that is defined by a number density on an altitude grid and an optical property

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

  • altitudes_m (np.array) – The altitude grid in [m]

  • number_density (np.array) – Number density in [m^-3]

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

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

__init__(optical_property: OpticalProperty, altitudes_m: array, number_density: array, out_of_bounds_mode: str = 'zero', **kwargs) None[source]#

A scattering constituent that is defined by a number density on an altitude grid and an optical property

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

  • altitudes_m (np.array) – The altitude grid in [m]

  • number_density (np.array) – Number density in [m^-3]

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

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

Methods

__init__(optical_property, altitudes_m, ...)

A scattering constituent that is defined by a number density on an altitude grid and an optical property

add_to_atmosphere(atmo)

register_derivative(atmo, name)

Attributes

altitudes_m

number_density