ImageTools
Clip
clip intensity to specified levels
Calling Sequence
Parameters
Options
Description
Examples
Clip( img, opts )
img
-
Image; the image to adjust
opts
(optional) equation(s) of the form option = value; specify options for the Clip command
high = realcons
Specifies the upper bound to which intensities are clipped. Intensities greater than this value are set equal to this value. By default there is no upper bound, however, if neither low nor high are specified, then the default value is 1.0.
inplace = truefalse
Specifies whether the operation is performed in-place. This can be used to avoid allocating memory. The default is false.
low = realcons
Specifies the lower bound to which intensities are clipped. Intensities less than this value are set equal to this value. By default there is no lower bound, however, if neither low nor high are specified, then the default value is 0.0.
output = Image
Specifies a data structure into which the output is written. This can be used to avoid allocating memory. The size and number of layers must match that of the input. The dimensions of the output image are adjusted so that the row and column indices match the input. The default is NULL.
The Clip command clips any pixel intensity value less than a lower bound to that bound, and greater than an upper bound to that bound.
The img parameter specifies the image to clip, and must be of type Image.
The options low and high specify the lower and upper bounds, respectively, to which intensities are clipped. If both low and high are unspecified, then they are assigned the values 0.0 and 1.0, respectively. That is, by default, intensities are clipped to be between 0 and 1, inclusive.
If both low and high are specified, and the value of low exceeds that of high, an error is generated.
If only one bound is specified, the other one is unbounded. For example, Clip(img, high = 0.5) clips all intensities in img to be less than or equal to 0.5.
The Clip command is often useful after performing other image processing operations that may have produced out-of-bound values, and before performing operations that are not defined on out-of-bound values.
with⁡ImageTools:
data≔Create⁡−0.2,0.,1.0,1.2
data≔−0.2000000000000000.1.1.20000000000000
Clip⁡data,low=0.1,high=0.9
0.1000000000000000.1000000000000000.9000000000000000.900000000000000
See Also
ImageTools[Gamma]
ImageTools[Scale]
Download Help Document