retrievalAddSpecialSpecies

Workspace.retrievalAddSpecialSpecies(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, jacobian_agenda: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Agenda]] = self.jacobian_agenda, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, covmat_block: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Sparse]] = self.covmat_block, covmat_inv_block: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Sparse]] = self.covmat_inv_block, p_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.p_grid, lat_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lat_grid, lon_grid: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.lon_grid, g1: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], g2: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], g3: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], species: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Same as jacobianAddSpecialSpecies() but also adds a new block to covmat_sx using the matrices in covmat_block and covmat_inv_block.

If covmat_inv_block is non-empty, it is used as inverse for the added block which avoids its numerical computation.

For number and order of elements added to x, see jacobianAddSpecialSpecies().

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

  • jacobian_agenda (Agenda, optional) – Pure numerical Jacobian calculations. See jacobian_agenda, defaults to self.jacobian_agenda [INOUT]

  • atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [IN]

  • covmat_block (Sparse, optional) – Holds matrices used to set blocks in covmat_sx and covmat_se. See covmat_block, defaults to self.covmat_block [IN]

  • covmat_inv_block (Sparse, optional) – Holds matrices used to set the inverse blocks in covmat_sx and covmat_se. See covmat_inv_block, defaults to self.covmat_inv_block [IN]

  • p_grid (Vector, optional) – The pressure grid. See p_grid, defaults to self.p_grid [IN]

  • lat_grid (Vector, optional) – The latitude grid. See lat_grid, defaults to self.lat_grid [IN]

  • lon_grid (Vector, optional) – The longitude grid. See lon_grid, defaults to self.lon_grid [IN]

  • g1 (Vector) – Pressure retrieval grid. [IN]

  • g2 (Vector) – Latitude retrieval grid. [IN]

  • g3 (Vector) – Longitude retreival grid. [IN]

  • species (String) – The species of the retrieval quantity. [IN]

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