skretrieval.retrieval.statevector.StateVectorElement

class skretrieval.retrieval.statevector.StateVectorElement(enabled: bool = True)

Bases: ABC

A state vector element is a component of the full state vector used in the retrieval. Each state vector element has a state, and a prior state/covariance associated with it. The state vector element must also be able to update itself, calculate the jacobian matrix for itself.

__init__(enabled: bool = True)

Methods

__init__([enabled])
add_to_linearization_tangent(tangent, x, ...)
apriori_state()
averaging_kernel_resolution_coordinates()	Return physical coordinates used for averaging-kernel moments.
averaging_kernel_row_sum_groups()	Label physical quantities within this state-vector element.
describe(**kwargs)
inverse_apriori_covariance()
linearization_gradient(gradient, ...)
linearization_parameter_names(tangent_template)
lower_bound()
modify_input_radiance(radiance)
name()
prior_precision_factor()	Return R such that R.T @ R is the prior precision.
propagate_wf(radiance)
state()
supports_linearization_products()
update_state(x)
upper_bound()

Attributes

enabled

averaging_kernel_resolution_coordinates() → dict[str, ndarray]

Return physical coordinates used for averaging-kernel moments.

averaging_kernel_row_sum_groups() → ndarray

Label physical quantities within this state-vector element.

prior_precision_factor()

Return R such that R.T @ R is the prior precision.