RanorexRanorex Documentation
FindImage Method (image, feature, similarityThreshold, windowRadius, maxMatches)
NamespacesRanorexImaging..::.ProcessingFindImage(Bitmap, Bitmap, Double, Int32, Int32)
Searches for the specified feature in the image and returns a list of Imaging..::.Matches.
Declaration Syntax
C#Visual BasicVisual C++
public static List<Imaging..::.Match> FindImage(
	Bitmap image,
	Bitmap feature,
	double similarityThreshold,
	int windowRadius,
	int maxMatches
)
Public Shared Function FindImage ( _
	image As Bitmap, _
	feature As Bitmap, _
	similarityThreshold As Double, _
	windowRadius As Integer, _
	maxMatches As Integer _
) As List(Of Imaging..::.Match)
public:
static List<Imaging..::.Match^>^ FindImage(
	Bitmap^ image, 
	Bitmap^ feature, 
	double similarityThreshold, 
	int windowRadius, 
	int maxMatches
)
Parameters
image (Bitmap)
The image to search in.
feature (Bitmap)
The image to search for.
similarityThreshold (Double)
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 (Int32)
Specifies the radius of a window in which only the match with the greatest similarity is reported.
maxMatches (Int32)
Defines the maximum number of matches to return; or 0 to not define a limit for the number of matches.
Return Value
A list of Imaging..::.Matches 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.

Assembly: Ranorex.Core (Module: Ranorex.Core) Version: 3.2.3.16825 (3.2.3.16825)