You are here: Start » Function Reference » Image Metrics » ImageCorrelationImage
ImageCorrelationImage
Computes an image of correlation between a pattern and the input image at each possible location.
Syntax
void avl::ImageCorrelationImage ( const avl::Image& inImage, const avl::Image& inPatternImage, atl::Optional<const avl::Region&> inRoi, atl::Optional<const avl::Region&> inPatternRoi, avl::CorrelationMeasure::Type inCorrelationMeasure, avl::Image& outImage )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inImage | const Image& | Input image | ||
inPatternImage | const Image& | Pattern to be compared with input image | ||
inRoi | Optional<const Region&> | NIL | Range of pixels to be processed | |
inPatternRoi | Optional<const Region&> | NIL | Range of pixels in the pattern to be processed | |
inCorrelationMeasure | CorrelationMeasure::Type | Measure of correlation | ||
outImage | Image& | Output image |
Description
The operation computes the correlation between inImage and inPatternImage. The inPatternImage is aligned at each location of the inImage and the similarity between the inPatternImage and the corresponding part of the inImage is estimated using the inCorrelationMeasure as in ImageCorrelation filter. The result is stored in the pixel of the outImage that corresponds to the location at which the center of inPatternImage was aligned to the inImage.
Examples
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
This operation supports processing on OpenCL compatible device (when inRoi=NIL, inPatternRoi=NIL and pixel type is uint8).
Errors
Error type | Description |
---|---|
DomainError | Not supported correlation measure in ImageCorrelationImage. |