retrievalAddAbsSpecies
- Workspace.retrievalAddAbsSpecies(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], unit: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = "rel", for_species_tag: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = 1, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) None
Adds an absorption species to the retrieval quantities.
Similar to
jacobianAddAbsSpecies()
but also sets the corresponding block incovmat_sx
to the matrices provided incovmat_block
andcovmat_inv_block
. The dimensions ofcovmat_block
are required to agree with the dimensions of the retrieval grid.covmat_inv_block
must be either empty or the same dimension ascovmat_block
. If provided, this matrix will be used as the inverse for the covariance matrix block and numerical inversion of this block is thus avoided. Note, however, that this is only effective if this block is uncorrelated with any other retrieval quantity.For number and order of elements added to
x
, seejacobianAddAbsSpecies()
.Author(s): Simon Pfreundschuh
- Parameters:
covmat_sx (CovarianceMatrix, optional) – Covariance matrix of a priori distribution. See
covmat_sx
, defaults toself.covmat_sx
[INOUT]jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See
jacobian_quantities
, defaults toself.jacobian_quantities
[INOUT]jacobian_agenda (Agenda, optional) – Pure numerical Jacobian calculations. See
jacobian_agenda
, defaults toself.jacobian_agenda
[INOUT]atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See
atmosphere_dim
, defaults toself.atmosphere_dim
[IN]covmat_block (Sparse, optional) – Holds matrices used to set blocks in
covmat_sx
andcovmat_se
. Seecovmat_block
, defaults toself.covmat_block
[IN]covmat_inv_block (Sparse, optional) – Holds matrices used to set the inverse blocks in
covmat_sx
andcovmat_se
. Seecovmat_inv_block
, defaults toself.covmat_inv_block
[IN]p_grid (Vector, optional) – The pressure grid. See
p_grid
, defaults toself.p_grid
[IN]lat_grid (Vector, optional) – The latitude grid. See
lat_grid
, defaults toself.lat_grid
[IN]lon_grid (Vector, optional) – The longitude grid. See
lon_grid
, defaults toself.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 tag of the retrieval quantity. [IN]
unit (String, optional) – Retrieval unit. See above. Defaults to
"rel"
[IN]for_species_tag (Index, optional) – Index-bool for acting on species tags or species. Defaults to
1
[IN]verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]