xClip

Workspace.xClip(self: pyarts.arts._Workspace, x: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.x, jacobian_quantities: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfRetrievalQuantity]] = self.jacobian_quantities, ijq: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index], 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 the state vector.

The method allows you to apply hard limits the values of a retrieval quantity. The retrieval quantity is specified by ijq. All values of the quantity 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 ijq=-1, is a shortcut for applying the limits on all retrieval quantities.

Notice that limits must be specified in the unit used in x.

Author(s): Patrick Eriksson

Parameters:

• x (Vector, optional) – The state vector. See x, defaults to self.x [INOUT]

• jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]

• ijq (Index) – Retrieval quantity index (zero-based). [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]