Click or drag to resize
Ranorex

ImagingCompare Method (Bitmap, Bitmap, ImagingFindOptions)

Compares image and feature and returns whether their similarity is greater than or equal to the value specified by options.Similarity.

Namespace:  Ranorex
Assembly:  Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06
Syntax
public static bool Compare(
	Bitmap image,
	Bitmap feature,
	ImagingFindOptions options
)

Parameters

image
Type: System.DrawingBitmap
The first image.
feature
Type: System.DrawingBitmap
The second image.
options
Type: RanorexImagingFindOptions
The options for the image comparison. The Preprocessing options are applied to both images, the Clipping rectangle only to image. The Similarity defines the minimum similarity the images need to have.

Return Value

Type: Boolean
True if the similarity of the two (preprocessed) images is greater than or equal to options.Similarity.
Exceptions
ExceptionCondition
ArgumentNullExceptionIf image is null.
ArgumentNullExceptionIf feature is null.
ArgumentExceptionIf the bitmap format of the feature cannot be converted to that of the image.
Remarks
False will be returned if the two images (after clipping image using the rectangle value of options.Clipping) do not have the same size.
See Also