State Vectors

class StateVectorAerosolProfile(altitudes_m: array, values: array, species_name: str, optical_property: OpticalProperty, lowerbound: float, upperbound: float, second_order_tikhonov_factor: ndarray = array([0., 0.]), second_order_tikhonov_altitude: ndarray = array([0., 100000.]), bounding_factor=10000.0, zero_factor: float = 1e-20, max_update_factor: float = 5, scale_range: float = 200)

A state vector element which defines a vertical profile as the logarithm of number density. The profile is bounded above and below by the upperbound and lowerbound through the use of the apriori. A second order tikhonov smoothing is included. Number dennsities less than a certain factor (zero_factor) are treated as identically equal to 0 within the RTM to prevent numerical precision problems

Parameters:

• altitudes_m (np.array) – Altitudes of the profile, should match weighting function altitudes

• values (np.array) – log(number density) for the profile

• species_name (str) – Name of the species in the atmosphere

• optical_property (sk.OpticalProperty) – Optical property of the species

• lowerbound (float) – Lowerbound of the retrieval in m

• upperbound (float) – Upperbound of the retrieval in m

• second_order_tikhonov_factor (np.ndarray) – Altitude dependent second order tikhonov factor, should be the same size as second_order_tikhonov_altitude

• second_order_tikhonov_altitude (np.ndarray) – Altitudes of Tikhonov factors, should be the same size as second_order_tikhonov_factor

• bounding_factor (float, optional) – Bounding factor used for the apriori upper/lower bounding. Default 1e4

• zero_factor (float, optional) – Number densities less than this number are treated as identically 0. Default 1e-20

• max_update_factor (float, optional) – Maximum factor to update any element of the state vector every iteration. Default 5

• scale_range (float) – The range in km that is used for scaling of the profile below the upper bound and above the lower bound. For example, if the upper_bound is 40km and scale_range is 5km, then the range between 35 and 40km will be used as the region to determine the scale factor above 40km.

add_to_atmosphere(atmosphere: Atmosphere)

Adds the species to the atmosphere

Parameters:

atmosphere (sk.Atmosphere) –

property lower_scale_alts

Altitudes in the lower altitude range used for profile scaling

property upper_scale_alts

Altitudes in the upper altitude range used for profile scaling

class StateVectorProfileParticleSize(altitudes_m: array, values: array, species_name: str, optical_property: OpticalProperty, size_type: str, lowerbound: float, upperbound: float, second_order_tikhonov_factor: ndarray = array([0., 0.]), second_order_tikhonov_altitude: ndarray = array([0., 100000.]), bounding_factor=10000.0, zero_factor: float = 1e-20, max_update_factor: float = 5)

A state vector element which defines a vertical profile as the logarithm of number density. The profile is bounded above and below by the upperbound and lowerbound through the use of the apriori. A second order tikhonov smoothing is included. Number dennsities less than a certain factor (zero_factor) are treated as identically equal to 0 within the RTM to prevent numerical precision problems

Parameters:

• altitudes_m (np.array) – Altitudes of the profile, should match weighting function altitudes

• values (np.array) – log(number density) for the profile

• species_name (str) – Name of the species in the atmosphere

• optical_property (sk.OpticalProperty) – Optical property of the species

• lowerbound (float) – Lowerbound of the retrieval in m

• upperbound (float) – Upperbound of the retrieval in m

• second_order_tikhonov_factor (np.ndarray) – Altitude dependent second order tikhonov factor, should be the same size as second_order_tikhonov_altitude

• second_order_tikhonov_altitude (np.ndarray) – Altitudes of Tikhonov factors, should be the same size as second_order_tikhonov_factor

• bounding_factor (float, optional) – Bounding factor used for the apriori upper/lower bounding. Default 1e4

• zero_factor (float, optional) – Number densities less than this number are treated as identically 0. Default 1e-20

• max_update_factor (float, optional) – Maximum factor to update any element of the state vector every iteration. Default 5

• scale_range (float) – The range in km that is used for scaling of the profile below the upper bound and above the lower bound. For example, if the upper_bound is 40km and scale_range is 5km, then the range between 35 and 40km will be used as the region to determine the scale factor above 40km.

add_to_atmosphere(atmosphere: Atmosphere)

Adds the species to the atmosphere

Parameters:

atmosphere (sk.Atmosphere) –

property lower_scale_alts

Altitudes in the lower altitude range used for profile scaling

property upper_scale_alts

Altitudes in the upper altitude range used for profile scaling