vmr_fieldClip

Workspace.vmr_fieldClip(self: pyarts.arts._Workspace, vmr_field: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Tensor4]] = self.vmr_field, abs_species: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfArrayOfSpeciesTag]] = self.abs_species, species: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.String], limit_low: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = -std::numeric_limits<Numeric>::infinity(), limit_high: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = std::numeric_limits<Numeric>::infinity(), verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Clipping of vmr_field.

The method allows you to apply hard limits the values of vmr_field. All values, of the species selected, below limit_low, are simply set to limit_low. And the same is performed with respect to limit_high. That is, the data in x for the retrieval quantity are forced to be inside the range [limit_low,limit_high].

Setting species=”ALL”, is a shortcut for applying the limits on all species.

Author(s): Patrick Eriksson

Parameters:

  • vmr_field (Tensor4, optional) – VMR field. See vmr_field, defaults to self.vmr_field [INOUT]

  • abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See abs_species, defaults to self.abs_species [IN]

  • species (String) – Name of species to consider, or “ALL”. [IN]

  • limit_low (Numeric, optional) – Lower limit for clipping. Defaults to -Inf [IN]

  • limit_high (Numeric, optional) – Upper limit for clipping. Defaults to Inf [IN]

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