skretrieval.retrieval.statevector.constituent.StateVectorElementConstituent

class skretrieval.retrieval.statevector.constituent.StateVectorElementConstituent(constituent: Constituent, constituent_name: str, property_names: list[str], min_value=None, max_value=None, prior: dict[BasePrior] | None = None, log_space: bool | Mapping[str, bool] = False, enabled=True, scale_factor: float | Mapping[str, float] = 1.0)

Bases: StateVectorElement, Constituent

A state vector element that is a sasktran2.constituent

Parameters:

• constituent (sk2.constituent.base.Constituent) – The sasktran2 constituent

• constituent_name (str) – A name for the constituent

• property_names (list[str]) – Property names of the constituent that will be retrieved

• min_value (dict, optional) – Minimum values for the property names as a dictionary, by default {}

• max_value (dict, optional) – maximumum values for the property names as a dictionary, by default {}

• prior (dict, optional) – Prior objects for each property name, by default {}

• log_space (bool or mapping, optional) – If true then all properties are represented logarithmically. A mapping selects the parameterization independently for each property, by default False.

• scale_factor (float or mapping, optional) – Constant multiplicative factor between constituent properties and retrieval state. A mapping selects the factor independently for each property. A linear state value of 1 corresponds to a constituent property value of 1 / scale_factor, by default 1.0.

__init__(constituent: Constituent, constituent_name: str, property_names: list[str], min_value=None, max_value=None, prior: dict[BasePrior] | None = None, log_space: bool | Mapping[str, bool] = False, enabled=True, scale_factor: float | Mapping[str, float] = 1.0)

A state vector element that is a sasktran2.constituent

Parameters:

• constituent (sk2.constituent.base.Constituent) – The sasktran2 constituent

• constituent_name (str) – A name for the constituent

• property_names (list[str]) – Property names of the constituent that will be retrieved

• min_value (dict, optional) – Minimum values for the property names as a dictionary, by default {}

• max_value (dict, optional) – maximumum values for the property names as a dictionary, by default {}

• prior (dict, optional) – Prior objects for each property name, by default {}

• log_space (bool or mapping, optional) – If true then all properties are represented logarithmically. A mapping selects the parameterization independently for each property, by default False.

• scale_factor (float or mapping, optional) – Constant multiplicative factor between constituent properties and retrieval state. A mapping selects the factor independently for each property. A linear state value of 1 corresponds to a constituent property value of 1 / scale_factor, by default 1.0.

Methods

__init__(constituent, constituent_name, ...)	A state vector element that is a sasktran2.constituent
add_to_atmosphere(atmo)
add_to_linearization_tangent(tangent, x, ...)
adjust_constituent_attributes(**kwargs)
apriori_state()
averaging_kernel_resolution_coordinates()	Return physical coordinates used for averaging-kernel moments.
averaging_kernel_row_sum_groups()	Keep averaging-kernel row sums within each physical property.
describe(**kwargs)
inverse_apriori_covariance()
linearization_gradient(gradient, ...)
linearization_parameter_names(tangent_template)
lower_bound()
modify_input_radiance(radiance)
name()
prior_precision_factor()	Return the prior residual operator in retrieval-state coordinates.
propagate_wf(radiance)
register_derivative(atmo, name)
state()
supports_linearization_products()
update_state(x)
upper_bound()

Attributes

enabled
volume_spatial_mode	Preserve the wrapped constituent's spatial input convention.

averaging_kernel_row_sum_groups() → ndarray

Keep averaging-kernel row sums within each physical property.

prior_precision_factor()

Return the prior residual operator in retrieval-state coordinates.

property volume_spatial_mode

Preserve the wrapped constituent’s spatial input convention.