jacobianAddBasicCatalogParameter

Workspace.jacobianAddBasicCatalogParameter(self: pyarts.arts._Workspace, 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, catalog_identity: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.QuantumIdentifier], catalog_parameter: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Includes a basic catalog parameter in the Jacobian. These are constant over all layers and so only a single vector output is returned.

The only basic catalog parameters currently supported are:

  • "LineStrength"

  • "LineCenter"

The catalog_identity should be able to identify one or many lines in the catalog used for calculating the spectral absorption. Note that partial matching for energy levels are allowed but not recommended, as it is somewhat nonsensical to add multiple parameters.

Also note jacobianAddShapeCatalogParameter() as this allows addition of shape parameters, e.g., pressure broadening coefficients.

Each call to this function adds just a single value to x.

Example given the catalog_identity=”O2-66 TR UP v1 0 J 1 LO v1 0 J 0”, only the O2 ground-level 119 GHz line can be accessed and only its catalog_parameter will be accessed. However, the more lenient catalog_identity=”O2-66 TR UP J 1 LO J 0” may be used, but then the 118 GHz line belonging to v1=1 branch will be added to the same x.

Author(s): Richard Larsson

Parameters:

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

  • catalog_identity (QuantumIdentifier) – The catalog line matching information. [IN]

  • catalog_parameter (String) – The catalog parameter of the retrieval quantity. [IN]

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