 | 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
Syntaxpublic static bool Compare(
Bitmap image,
Bitmap feature,
ImagingFindOptions options
)
Public Shared Function Compare (
image As Bitmap,
feature As Bitmap,
options As ImagingFindOptions
) As Boolean
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:
BooleanTrue if the similarity of the two (preprocessed) images is greater than or equal
to
options.
Similarity.
Exceptions| Exception | Condition |
|---|
| ArgumentNullException | If image is null. |
| ArgumentNullException | If feature is null. |
| ArgumentException | If the bitmap format of the feature
cannot be converted to that of the image. |
RemarksFalse 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