Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Image » Image Local Transforms » GradientImage

GradientImage


Module: FoundationLite

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

Name Type Range Description
Input value inImage Image Input image
Input value inRoi Region* Range of outGradientImage pixels to be computed
Input value inOperator GradientOperator Defines how the gradient is computed
Input value inStdDevX Real 0.0 - Horizontal smoothing standard deviation
Input value inStdDevY Real* 0.0 - Vertical smoothing standard deviation
Output value outGradientImage Image Gradients of the image
Diagnostic input diagGradientDirections Image Gradient 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.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

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

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of GradientImage filter group.