jacobianAddSurfaceQuantity

Workspace.jacobianAddSurfaceQuantity(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, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, 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], quantity: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Includes a surface quantity in the Jacobian.

The quantity is specified by the GIN-variable quantity. The name of the quantity must match the name used in surface_props_names.

For 1D or 2D calculations the latitude and/or longitude grid of the retrieval field should set to have zero length.

The number of elements added to the state vector (x) is:

n_g1 * n_g2

where n_g1 and n_g2 are the length of GIN g1 and g2, respectively. Here empty vectors should be considered to have a length 1. The elements are sorted with latitude as innermost loop and longitude as outermost loop.

Author(s): Patrick Eriksson

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]

  • atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [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) – Latitude retrieval grid. [IN]

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

  • quantity (String) – Retrieval quantity, e.g. “Wind speed”. [IN]

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