VectorClip

Workspace.VectorClip(self: pyarts.arts._Workspace, output: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], input: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], 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 a vector.

The input vector is copied to the output one (that can be same WSV) but ensures that all values in output are inside the range [limit_low, limit_high]. Where the input vector is below limit_low, out is set to limit_low. And the same is performed with respect to limit_high. That is, the method works as NumericClip() for each element of the vector.

The method adopts the length of out when needed.

Author(s): Patrick Eriksson

Parameters:
  • output (Vector) – Output vector. [OUT]

  • input (Vector) – Input vector. [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]