com.tplan.robot.imagecomparison.search

Class ExactSearchModule

java.lang.Object

com.tplan.robot.imagecomparison.search.AbstractImagePattern

com.tplan.robot.imagecomparison.search.ExactSearchModule

Direct Known Subclasses:

SearchImageComparisonModule, SearchImageComparisonModule2

public class ExactSearchModule
extends AbstractImagePattern

Search image comparison module (subclass).

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
long	endTime Performance time counters (nanoseconds).
long	heurTime Performance time counters (nanoseconds).
long	histTime Performance time counters (nanoseconds).
long	startTime Performance time counters (nanoseconds).

Constructor Summary

Constructors

Constructor and Description
ExactSearchModule()

Method Summary

Modifier and Type	Method and Description
Map<Rectangle,int[]>	getAllFailedPixels()
List<Integer>	getForbiddenColors()
int	getMinAlpha()
int	getRgbTolerance() Get tolerance to color variance (default is 0).
String	getType() Get the type (name) of the image comparison method.
boolean	isHeuristicsDefined()
boolean	matches(int[] source, int offset, Rectangle sourceRect, float passRate) Find out if the pattern matches with source pixels at a specified offset.
void	rebuildHeuristics(float passRate)
void	resetHeuristics()
void	setForbiddenColors(List<Integer> forbiddenColors)
void	setHeurIndex(int index)
void	setMinAlpha(int minAlpha)
void	setRgbTolerance(int rgbTolerance) Set tolerance to color variance.
void	setTrackingOfFailedPixelsEnabled(boolean enabled)

Methods inherited from class com.tplan.robot.imagecomparison.search.AbstractImagePattern

findPattern, getNumberOfNonAlphaPixels, getPixels, getRectangle, getStampAsString, isStopped, parseStampFromString, setPixels, setPixelsFromImage, stop, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

startTime

public long startTime

Performance time counters (nanoseconds).

histTime

public long histTime

Performance time counters (nanoseconds).

heurTime

public long heurTime

Performance time counters (nanoseconds).

endTime

public long endTime

Performance time counters (nanoseconds).

Constructor Detail

ExactSearchModule

public ExactSearchModule()

Method Detail

getType

public String getType()

Get the type (name) of the image comparison method. It describes and uniquely identifies the search method used, e.g. "Exact match", "Shape match" etc.

Specified by:

getType in class AbstractImagePattern

Returns:

This implementation always returns "Exact match".

setHeurIndex

public void setHeurIndex(int index)

rebuildHeuristics

public void rebuildHeuristics(float passRate)

setTrackingOfFailedPixelsEnabled

public void setTrackingOfFailedPixelsEnabled(boolean enabled)

getAllFailedPixels

public Map<Rectangle,int[]> getAllFailedPixels()

resetHeuristics

public void resetHeuristics()

isHeuristicsDefined

public boolean isHeuristicsDefined()

Returns:

the heuristicsDefined

setMinAlpha

public void setMinAlpha(int minAlpha)

Parameters:

minAlpha - the minAlpha to set

getMinAlpha

public int getMinAlpha()

Returns:

the minAlpha

getRgbTolerance

public int getRgbTolerance()

Get tolerance to color variance (default is 0).

Returns:

the tolerance value.

setRgbTolerance

public void setRgbTolerance(int rgbTolerance)

Set tolerance to color variance.

Parameters:

rgbTolerance - tolerance value (1-100).

getForbiddenColors

public List<Integer> getForbiddenColors()

Returns:

the forbiddenColors

setForbiddenColors

public void setForbiddenColors(List<Integer> forbiddenColors)

Parameters:

forbiddenColors - the forbiddenColors to set

matches

public boolean matches(int[] source,
                       int offset,
                       Rectangle sourceRect,
                       float passRate)

Description copied from class: AbstractImagePattern

Find out if the pattern matches with source pixels at a specified offset.

Specified by:

matches in class AbstractImagePattern

Parameters:

source - source pixels (usually pixels of a certain area of the remote desktop image)

offset - from which pixel array index to compare

sourceRect - rectangle identifying the area from to which the source pixels belong to

passRate - the pass rate between 0 and 1.

Returns:

true if the pixels at the specified offset match the pattern, false otherwise