covmat_sxAddInverseBlock

Workspace.covmat_sxAddInverseBlock(self: pyarts.arts._Workspace, covmat_sx: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.CovarianceMatrix]] = self.covmat_sx, jacobian_quantities: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfRetrievalQuantity]] = self.jacobian_quantities, block: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix, pyarts.arts.Sparse], i: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = -1, j: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = -1, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Add the inverse of a block in covariance matrix covmat_sx

This functions adds a given matrix as the inverse of a block in the covariance matrix covmat_sx. The purpose of this function is to allow the user to to use a precomputed inverse for this block in the covariance matrix, the may for example by obtained analytically.

This function requires the non-inverse block to already be present in covmat_sx If the ‘i’ and ‘j’ input arguments are not given, the inverse block will be added at the position of the most recently added non-inverse diagonal block.

Note that for this to work this retrieval quantity must be independent from other retrieval quantities that do not have an inverse. Otherwise the inverse will be ignored and recomputed numerically.

For the rest, the same requirements as for covmat_sxAddBlock() apply.

Author(s): Simon Pfreundschuh

Parameters:

  • covmat_sx (CovarianceMatrix, optional) – Covariance matrix of a priori distribution. See covmat_sx, defaults to self.covmat_sx [INOUT]

  • jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]

  • block (Matrix or Sparse) – The inverse block to add to the covariance matrix. [IN]

  • i (Index, optional) – Index of a retrieval quantity. Must satisfy i <= j. Defaults to -1 [IN]

  • j (Index, optional) – Index of a retrieval quantity. Must satisfy i <= j. Defaults to -1 [IN]

  • verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]