AtmFieldPerturb

Workspace.AtmFieldPerturb(self: pyarts.arts._Workspace, perturbed_field: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Tensor3], atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, 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, original_field: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Tensor3], p_ret_grid: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], lat_ret_grid: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], lon_ret_grid: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], pert_index: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index], pert_size: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric], pert_mode: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String]] = "absolute", verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Adds a perturbation to an atmospheric field.

The shape and position of the perturbation follow the retrieval grids. That is, the shape of the perturbation has a traingular shape, with breake points at the retrieval grid points. The position is given as an index. This index matches the column in the Jacobian for the selected grid position.

If the retrieval grids fully match the atmospheric grids, you can use AtmFieldPerturbAtmGrids(), that is faster. The description of that method can help to understand this method.

Author(s): Patrick Eriksson

Parameters:

  • perturbed_field (Tensor3) – Perturbed/modified field. [OUT]

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

  • original_field (Tensor3) – Original field, e.g. t_field. [IN]

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

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

  • lon_ret_grid (Vector) – Longitude retrieval grid. [IN]

  • pert_index (Index) – Index of position where the perturbation shall be performed. [IN]

  • pert_size (Numeric) – Size of perturbation. [IN]

  • pert_mode (String, optional) – Type of perturbation, absolute or relative. Defaults to "absolute" [IN]

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