ARTS built-in documentation server

Workspace Method xClip

Description

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.

Authors: Patrick Eriksson

Synopsis

xClip(

x, jacobian_quantities, ijq, limit_low, limit_high )

Variables

OUT+IN	x	(Vector)	The state vector.
IN	jacobian_quantities	(ArrayOfRetrievalQuantity)	The retrieval quantities in the Jacobian matrix.
GIN	ijq	(Index)	Retrieval quantity index (zero-based)
GIN	limit_low	(Numeric, Default: -Inf)	Lower limit for clipping.
GIN	limit_high	(Numeric, Default: Inf)	Upper limit for clipping.