Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Metrics » CompareImages_CVG

CompareImages_CVG


Header: FIL.h
Namespace: fil
Module: FoundationPro

Compares two images tile by tile using one of several available methods.

Syntax

C++
C#
 
void fil::CompareImages_CVG
(
	const fil::Image& inImage1,
	const fil::Image& inImage2,
	float inChromaAmount,
	float inValueAmount,
	float inGradientAmount,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value inImage1 const Image& First input image
Input value inImage2 const Image& Second input image
Input value inChromaAmount float 0.0 - 0.6f Proportion of chromatic information in output image
Input value inValueAmount float 0.0 - 0.3f Proportion of value information in output image
Input value inGradientAmount float 0.0 - 0.1f Proportion of gradient information in output image
Output value outImage Image& Output image

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Formats of input images differ in CompareImages_CVG.
DomainError Images sizes are not equal in CompareImages_CVG.