GradientImage


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

Syntax

C++
Python
 
def GradientImage(
	inImage: Image,
	outGradientImage: Image,
	/,
	*,
	inRoi: Region | None = None,
	inOperator: GradientOperator = GradientOperator.Gauss,
	inStdDevX: float = 2.0,
	inStdDevY: float | None = None,
	diagGradientDirections: Image | None = None
)
-> None

Parameters

Name Type Range Default Description
Input value inImage Image Input image
Input value inRoi Region | None None Range of outGradientImage pixels to be computed
Input value inOperator GradientOperator GradientOperator.Gauss Defines how the gradient is computed
Input value inStdDevX float 0.0 - 2.0 Horizontal smoothing standard deviation
Input value inStdDevY float | None 0.0 - None Vertical smoothing standard deviation
Output value outGradientImage Image Gradients of the image
Diagnostic input diagGradientDirections Image | None None Gradient directions presented in a human readable format

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.