Start » Filter Reference » Image » Image Local Transforms » ConvolveImage
Advanced| Module: | FoundationLite |
|---|
Computes a convolution of the input image with a user-specified mask.
Applications
Non-standard local transforms defined by the user.
| Name | Type | Description | |
|---|---|---|---|
 |
inImage | Image | Input image |
|
inRoi | Region* | Range of outImage pixels to be computed |
|
inMask | Matrix | Image convolution kernel |
|
inNormalizeMaskValues | Bool | Normalize sum of weights in mask to one |
|
inMaskOrigin | Location* | Relative location of point to its mask |
 |
outImage | Image | Output image |
Description
The operation computes new value of pixel as a convolution of inImage pixels and the inMask values.
Pixels which mask exceeds inRoi region are set to black. Input and output pixel have the same type.
If result value does not fit into pixel type you should use ConvertPixelType.
Examples
 |
 |
ConvolveImage performed on the sample image with inMask \( \begin{pmatrix} -1 & -2 & -1 \\ 0 & 0 & 0 \\ 1 & 2 & 1 \\ \end{pmatrix} \).
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
This operation supports processing on OpenCL compatible device (when inRoi=NIL).
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 | Empty convolution mask on input in ConvolveImage. |
| DomainError | Mask origin is outside the dimensions of the mask in ConvolveImage. |
| DomainError | Region exceeds an input image in ConvolveImage. |
| DomainError | Sum of weights in Mask is equal zero. Cannot normalize values in ConvolveImage. |
Complexity Level
This filter is available on Advanced Complexity Level.