skretrieval.retrieval.statevector.StateVector

class skretrieval.retrieval.statevector.StateVector(elements: Iterable[StateVectorElement])

Bases: object

A full state vector made up of a collection of state vector elements.

Parameters:

elements (Iterable[StateVectorElement]) – A collection of state vector elements

__init__(elements: Iterable[StateVectorElement])

A full state vector made up of a collection of state vector elements.

Parameters:

elements (Iterable[StateVectorElement]) – A collection of state vector elements

Methods

__init__(elements)	A full state vector made up of a collection of state vector elements.
describe(rodgers_output, **kwargs)
update_sasktran_radiance(radiance[, drop_old_wf])	Modifies radiances output from sasktran based on the state vector elements if applicable, e.g., if a state vector element is a wavelength shift this will apply it.

Attributes

state_elements

update_sasktran_radiance(radiance: Dataset, drop_old_wf: bool = False)

Modifies radiances output from sasktran based on the state vector elements if applicable, e.g., if a state vector element is a wavelength shift this will apply it.

Propagates weighting functions from the sasktran radiance raw output to weighting functions for each state vector element.

If drop_old_wf is set to true then the old weighting functions are removed from the radiance.

Parameters:

• radiance (xr.Dataset) – Output from sk.Engine.calculate_radiance(output_format=’xarray’)

• drop_old_wf (bool, Optional) – If true then the old weighting functions are removed after being propagated to the state vector. Default False

Returns:

radiance – Modified radiance with a new key ‘wf’ that is the jacobian with respect to the full state vector.

Return type:

xr.Dataset