You are here: Start » FIL.NET » Function Reference » Image » Image Local Transforms » FIL.GradientImage

FIL.GradientImage

Computes a gradient image with smoothing operator of any size. The output pixels are signed.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void GradientImage
(
	FilNet.Image inImage,
	NullableRef<FilNet.Region> inRoi,
	FilNet.GradientOperator inOperator,
	float inStdDevX,
	float? inStdDevY,
	FilNet.Image outGradientImage,
	FilNet.Image diagGradientDirections
)

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inRoiFilNet.NullableRef<FilNet.Region>Range of outGradientImage pixels to be computed. Default value: ftl::NIL.
inOperatorFilNet.GradientOperatorDefines how the gradient is computed.
inStdDevXfloat<0.0f, INF>2.0fHorizontal smoothing standard deviation. Default value: 2.0f.
inStdDevYfloat?<0.0f, INF>Vertical smoothing standard deviation. Default value: ftl::NIL.
outGradientImageFilNet.ImageGradients of the image.
diagGradientDirectionsFilNet.ImageGradient directions presented in a human readable format.

Remarks

Please note that about a half of the pixels will be negative and in the preview windows they will be displayed as black.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Hardware acceleration settings may be manipulated with Settings class.

Errors

List of possible exceptions:

Error type Description
DomainError Region exceeds an input image in GradientImage.

Function Overrides

See also