retrievalDefInit

Workspace.retrievalDefInit(self: pyarts.arts._Workspace, covmat_se: pyarts.arts.WorkspaceVariable | pyarts.arts.CovarianceMatrix | None = self.covmat_se, covmat_sx: pyarts.arts.WorkspaceVariable | pyarts.arts.CovarianceMatrix | None = self.covmat_sx, covmat_block: pyarts.arts.WorkspaceVariable | pyarts.arts.Sparse | None = self.covmat_block, covmat_inv_block: pyarts.arts.WorkspaceVariable | pyarts.arts.Sparse | None = self.covmat_inv_block, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, jacobian_agenda: pyarts.arts.WorkspaceVariable | pyarts.arts.Agenda | None = self.jacobian_agenda, initialize_jacobian: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 1, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) → None

Begin retrieval definition section.

This function initialises all variables required for defining retrieval quantities and corresponding covariance matrices. By default, Jacobian quantities should be added withing the. retrieval definition section. If Jacobian quantities are defined separately initialize_jacobian must be set to 0, otherwise the quantities will be discarded.

Author(s): Simon Pfreundschuh

Parameters:

  • covmat_se (CovarianceMatrix, optional) – Covariance matrix for observation uncertainties. See covmat_se, defaults to self.covmat_se [OUT]

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

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

  • 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 [OUT]

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

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

  • initialize_jacobian (Index, optional) – Flag whether or not to (re)initialize Jacobian-related quantities. Set to 0 if Jacobian is already defined. Defaults to 1 [IN]

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