org.safs.image

Class SmallPieceComparator

java.lang.Object

java.lang.Thread

org.safs.image.SmallPieceComparator

All Implemented Interfaces:

java.lang.Runnable

public class SmallPieceComparator
extends java.lang.Thread

 This class provides a way of multi-thread to search an image on screen, or to 
 search an image on a bigger image.
 The algorithm is different according to the size of the image to search.
 If the size is big:
   We will divide the image into small blocks, for each block, we use
   this class to create a thread to search it on screen from a fixed-start-point.
 If the size is small:
   We will divide the search rectangle to small blocks, for each small search
   rectangle, we use this class to create a thread to search the whole image
   on screen from a changable-start-point (each point in the small search rectangle
   will be tried as a start point until the image is found)
 

Author:

LeiWang
SEP 30, 2014 (LeiWang) Fix problem "Raster is bigger than image". Fix problem "Wrongly caculate the mis-match percentage". Combine the fuzzyMatching ability.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
SmallPieceComparator()
SmallPieceComparator(java.awt.image.BufferedImage screenImage, java.awt.image.BufferedImage targetImage, SharedLock lock, java.awt.Rectangle block, int screenStartx, int screenEndx, int screenStarty, int screenEndy, boolean moveScreenStartPoint) SmallPieceComparator Constructor.
SmallPieceComparator(java.awt.image.BufferedImage screenImage, java.awt.image.BufferedImage targetImage, SharedLock lock, java.awt.Rectangle block, int screenStartx, int screenEndx, int screenStarty, int screenEndy, boolean moveScreenStartPoint, boolean fuzzyMatching) SmallPieceComparator Constructor.
SmallPieceComparator(java.awt.image.DataBuffer screenshotBuffer, java.awt.image.SampleModel screenshot, java.awt.image.DataBuffer targetBuffer, java.awt.image.SampleModel target, SharedLock lock, java.awt.Rectangle block, int screenStartx, int screenEndx, int screenStarty, int screenEndy, boolean moveScreenStartPoint) SmallPieceComparator Constructor. NOTE: Be careful with DataBuffer and SampleModel parameters, sometimes they are bigger than the image itself and have an offset to show the begining point.

Method Summary

Modifier and Type	Method and Description
boolean	isInterrupted()
void	run()
void	setInterrupted(boolean interrupted)

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

SmallPieceComparator

public SmallPieceComparator()

SmallPieceComparator

public SmallPieceComparator(java.awt.image.BufferedImage screenImage,
                            java.awt.image.BufferedImage targetImage,
                            SharedLock lock,
                            java.awt.Rectangle block,
                            int screenStartx,
                            int screenEndx,
                            int screenStarty,
                            int screenEndy,
                            boolean moveScreenStartPoint)

SmallPieceComparator Constructor.

Parameters:

screenImage - BufferedImage, the screen image within which to find the target image.

targetImage - BufferedImage, the target image to find in the screen.

lock - SharedLock, the lock used to synchronize between main thread and search-thread.

block - Rectangle, a piece of targetImage or a piece of search-rectangle on screen.

screenStartx - int, the x-coordinate of start-search-point

screenEndx - int, the y-coordinate of start-search-point

screenStarty - int, the x-coordinate of end-search-point

screenEndy - int, the y-coordinate of end-search-point

moveScreenStartPoint - boolean, see moveScreenStartPoint

SmallPieceComparator

public SmallPieceComparator(java.awt.image.BufferedImage screenImage,
                            java.awt.image.BufferedImage targetImage,
                            SharedLock lock,
                            java.awt.Rectangle block,
                            int screenStartx,
                            int screenEndx,
                            int screenStarty,
                            int screenEndy,
                            boolean moveScreenStartPoint,
                            boolean fuzzyMatching)

SmallPieceComparator Constructor.

Parameters:

screenImage - BufferedImage, the screen image within which to find the target image.

targetImage - BufferedImage, the target image to find in the screen.

lock - SharedLock, the lock used to synchronize between main thread and search-thread.

block - Rectangle, a piece of targetImage or a piece of search-rectangle on screen.

screenStartx - int, the x-coordinate of start-search-point

screenEndx - int, the y-coordinate of start-search-point

screenStarty - int, the x-coordinate of end-search-point

screenEndy - int, the y-coordinate of end-search-point

moveScreenStartPoint - boolean, see moveScreenStartPoint

fuzzyMatching - boolean, if we can use fuzzy-matching-algorithm to match a pixel.

SmallPieceComparator

public SmallPieceComparator(java.awt.image.DataBuffer screenshotBuffer,
                            java.awt.image.SampleModel screenshot,
                            java.awt.image.DataBuffer targetBuffer,
                            java.awt.image.SampleModel target,
                            SharedLock lock,
                            java.awt.Rectangle block,
                            int screenStartx,
                            int screenEndx,
                            int screenStarty,
                            int screenEndy,
                            boolean moveScreenStartPoint)

SmallPieceComparator Constructor.
NOTE: Be careful with DataBuffer and SampleModel parameters, sometimes they are bigger than the image itself and have
an offset to show the begining point. Here we need these parameters reflect the same size of image.
If these parameters are got from an BufferedImage, you may call ImageUtils.copy(BufferedImage) and use the
copied image to get DataBuffer and SampleModel.

Parameters:

screenshotBuffer - DataBuffer, the databuffer of the screen image within which to find the target image.

screenshot - SampleModel, the sample-model the screen image within which to find the target image.

targetBuffer - DataBuffer, the databuffer of the target image to find in the screen.

target - SampleModel, the sample-model of the target image to find in the screen.

lock - SharedLock, the lock used to synchronize between main thread and search-thread.

block - Rectangle, a piece of targetImage or a piece of search-rectangle on screen.

screenStartx - int, the x-coordinate of start-search-point

screenEndx - int, the y-coordinate of start-search-point

screenStarty - int, the x-coordinate of end-search-point

screenEndy - int, the y-coordinate of end-search-point

moveScreenStartPoint - boolean, see moveScreenStartPoint

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

isInterrupted

public boolean isInterrupted()

Overrides:

isInterrupted in class java.lang.Thread

setInterrupted

public void setInterrupted(boolean interrupted)