Click or drag to resize
Ranorex

ImagingProcessingFindImage Method

Searches for the specified feature in the image and returns a list of ImagingMatches.

Namespace:  Ranorex
Assembly:  Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06
Syntax
Copy
public static List<ImagingMatch> FindImage(
	Bitmap image,
	Bitmap feature,
	double similarityThreshold,
	int windowRadius,
	int maxMatches,
	bool[,] ignoreMap = null
)

Parameters

image
Type: System.DrawingBitmap
The image to search in.
feature
Type: System.DrawingBitmap
The image to search for.
similarityThreshold
Type: SystemDouble
A value between 0.0 and 1.0 (inclusive) that defines the similarity the feature needs to have with the image to be considered a match.
windowRadius
Type: SystemInt32
Specifies the radius of a window in which only the match with the greatest similarity is reported.
maxMatches
Type: SystemInt32
Defines the maximum number of matches to return; or 0 to not define a limit for the number of matches.
ignoreMap (Optional)
Type: SystemBoolean
A two dimensional map of the reference image pixels. Is the pixel set to true in this map it will be ignored for comparison.

Return Value

Type: ListImagingMatch
A list of ImagingMatches found.
Exceptions
ExceptionCondition
ArgumentNullExceptionIf image is null.
ArgumentNullExceptionIf feature is null.
ArgumentOutOfRangeExceptionIf similarityThreshold lies outside the interval 0.0 and 1.0.
ArgumentOutOfRangeExceptionIf maxMatches is negative.
ArgumentExceptionIf the feature is greater in size than the image.
ArgumentExceptionIf the bitmap format of the feature cannot be converted to that of the image.
See Also