RetrievalAddWindField

Workspace.RetrievalAddWindField(self, jac_targets: pyarts3.arts.JacobianTargets | None = None, covmat_diagonal_blocks: pyarts3.arts.JacobianTargetsDiagonalCovarianceMatrixMap | None = None, component: pyarts3.arts.String | None = None, d: pyarts3.arts.Numeric | None = None, matrix: pyarts3.arts.BlockMatrix | None = None, inverse: pyarts3.arts.BlockMatrix | None = None) → None

Set wind field derivative.

Note that the derivatives from methods that takes the freqeuncy will return their derivatives as if these were frequency derivatives.

See FieldComponent for valid component

This method wraps jac_targetsAddWindField() together with adding the covariance matrices, to the covmat_diagonal_blocks, which are required to perform OEM().

The input covariance matrices must fit the size of the later computed model state represented by the jac_targets. The covariance matrix inverse

Author: Richard Larsson

Parameters:

  • jac_targets (JacobianTargets, optional) – A list of targets for the Jacobian Matrix calculations. See jac_targets, defaults to self.jac_targets [INOUT]

  • covmat_diagonal_blocks (JacobianTargetsDiagonalCovarianceMatrixMap, optional) – A helper map for setting the covariance matrix. See covmat_diagonal_blocks, defaults to self.covmat_diagonal_blocks [INOUT]

  • component (String) – The component to use [u, v, w]. [IN]

  • d (Numeric, optional) – The perturbation used in methods that cannot compute derivatives analytically. Defaults to 0.1 [IN]

  • matrix (BlockMatrix) – The covariance diagonal block matrix. [IN]

  • inverse (BlockMatrix, optional) – The inverse covariance diagonal block matrix. Defaults to pyarts3.arts.BlockMatrix() [IN]