skretrieval.retrieval.statevector.constituent.StateVectorElementConstituent

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=False, enabled=True, scale_factor: float = 1.0)[source]#

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, optional) – If true then the state elements will be rescaled to logarithmic space, by default False

  • scale_factor (float, optional) – Constant multiplicative factor between constituent properties and retrieval state. A 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=False, enabled=True, scale_factor: float = 1.0)[source]#

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, optional) – If true then the state elements will be rescaled to logarithmic space, by default False

  • scale_factor (float, optional) – Constant multiplicative factor between constituent properties and retrieval state. A 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)

adjust_constituent_attributes(**kwargs)

apriori_state()

describe(**kwargs)

inverse_apriori_covariance()

lower_bound()

modify_input_radiance(radiance)

name()

propagate_wf(radiance)

register_derivative(atmo, name)

state()

update_state(x)

upper_bound()

Attributes

enabled