covmat_sxAddBlock

Workspace.covmat_sxAddBlock(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 a block to the a priori covariance matrix covmat_sx

This functions adds a given matrix as a block in the covariance matrix covmat_sx. The position of the block can be given by the generic arguments i and j, which should give the index of the retrieval quantity in jacobian_quantities, which is given just by the order the quantities have been added to the retrieval.

If arguments i and j are omitted, the block will be added as diagonal block for the last added retrieval quantity.

If provided, the index i must be less than or equal to j. Also the provided block must be consistent with the corresponding retrieval quantities.

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 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]