skretrieval.retrieval.processing.Retrieval

skretrieval.retrieval.processing.Retrieval#

class skretrieval.retrieval.processing.Retrieval(observation: Observation, measvec: dict[MeasurementVector] | None = None, forward_model_cfg: dict | None = None, minimizer='rodgers', ancillary: Ancillary | None = None, l1_kwargs: dict | None = None, model_kwargs: dict | None = None, minimizer_kwargs: dict | None = None, target_kwargs: dict | None = None, state_kwargs: dict | None = None, **kwargs)[source]#

Bases: object

The main processing script that handles the retrieval

Parameters:

  • observation (Observation)

  • measvec (dict[MeasurementVector] | None, optional) – Measurement vectors to use, by default will use the raw radiances, by default None

  • minimizer (str, optional) – Selects which minimizer to use, default is “rodgers”, by default “rodgers”

  • l1_kwargs (dict | None, optional) – Additional arguments passed to the observation when constructing the L1, by default None

  • model_kwargs (dict | None, optional) – Additional arguments passed to the SASKTRAN2 engine, by default None

  • minimizer_kwargs (dict | None, optional) – Additional arguments passed to the minimizer, by default None

  • target_kwargs (dict | None, optional) – Additional arguments passed to the retrieval target, by default None

  • state_kwargs (dict | None, optional) – Arguments to construct the state vector, by default None

  • forward_model_cfg (dict | None, optional) – Additional arguments passed to the forward model, by default None

__init__(observation: Observation, measvec: dict[MeasurementVector] | None = None, forward_model_cfg: dict | None = None, minimizer='rodgers', ancillary: Ancillary | None = None, l1_kwargs: dict | None = None, model_kwargs: dict | None = None, minimizer_kwargs: dict | None = None, target_kwargs: dict | None = None, state_kwargs: dict | None = None, **kwargs) → None[source]#

The main processing script that handles the retrieval

Parameters:

  • observation (Observation)

  • measvec (dict[MeasurementVector] | None, optional) – Measurement vectors to use, by default will use the raw radiances, by default None

  • minimizer (str, optional) – Selects which minimizer to use, default is “rodgers”, by default “rodgers”

  • l1_kwargs (dict | None, optional) – Additional arguments passed to the observation when constructing the L1, by default None

  • model_kwargs (dict | None, optional) – Additional arguments passed to the SASKTRAN2 engine, by default None

  • minimizer_kwargs (dict | None, optional) – Additional arguments passed to the minimizer, by default None

  • target_kwargs (dict | None, optional) – Additional arguments passed to the retrieval target, by default None

  • state_kwargs (dict | None, optional) – Arguments to construct the state vector, by default None

  • forward_model_cfg (dict | None, optional) – Additional arguments passed to the forward model, by default None

Methods

__init__(observation[, measvec, ...])

The main processing script that handles the retrieval

register_context()

register_optical_property(species_name)

register_prior(species_name)

register_state(category, species_name)

retrieve([enabled_state_elements, ...])