ConvolveImage


Computes a convolution of the input image with a user-specified mask.

Applications:Non-standard local transforms defined by the user.

Syntax

C++
Python
 
def ConvolveImage(
	inImage: Image,
	inMask: Matrix,
	outImage: Image,
	/,
	*,
	inRoi: Region | None = None,
	inNormalizeMaskValues: bool = False,
	inMaskOrigin: Location | None = None
)
-> None

Parameters

Name Type Default Description
Input value inImage Image Input image
Input value inRoi Region | None None Range of outImage pixels to be computed
Input value inMask Matrix Image convolution kernel
Input value inNormalizeMaskValues bool False Normalize sum of weights in mask to one
Input value inMaskOrigin Location | None None Relative location of point to its mask
Output value outImage Image Output image

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

This operation supports processing on OpenCL compatible device (when inRoi=NIL).