org.sikuli.script

Class ImageFinder

java.lang.Object

org.sikuli.script.Finder

org.sikuli.script.ImageFinder

All Implemented Interfaces:

Iterator<Match>

public class ImageFinder
extends Finder

EXPERIMENTAL --- INTERNAL USE ONLY
is not official API --- will not be in version 2

Constructor Summary

Constructors

Constructor and Description
ImageFinder()
ImageFinder(Image base)
ImageFinder(IScreen scr)
ImageFinder(Region reg)

Method Summary

Modifier and Type	Method and Description
void	destroy() to explicitly free the Finder's resources
String	find(Image img) do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)
String	find(Pattern pat) do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)
String	find(String filenameOrText) do a find op with the given image or the given text in the Finder's image (hasNext() and next() will reveal possible match results)
String	findAll(Image img) do a findAll op with the given image in the Finder's image (hasNext() and next() will reveal possible match results)
String	findAll(Pattern pat) do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)
String	findAll(String filenameOrText) do a findAll op with the given image or the given text in the Finder's image (hasNext() and next() will reveal possible match results)
String	findText(String text) do a text find with the given text in the Finder's image (hasNext() and next() will reveal possible match results)
boolean	hasChanges(org.opencv.core.Mat current)
boolean	hasNext()
boolean	isImage()
boolean	isValid()
Match	next()
void	remove() not used
<PSI> ImageFind	search(PSI probe, Object... args)
<PSI> ImageFind	searchAll(PSI probe, int sorted, Object... args)
<PSI> ImageFind	searchAll(PSI probe, Object... args)
<PSI> ImageFind	searchAny(PSI probe, Object... args)
<PSI> ImageFind	searchSome(PSI probe, int count, Object... args)
<PSI> ImageFind	searchSome(PSI probe, Object... args)
void	setFindTimeout(double t)
boolean	setImage(Image base)
void	setIsMultiFinder()
void	setMinChanges(int min)
boolean	setRegion(Region reg)
boolean	setScreen(IScreen scr)

Methods inherited from class org.sikuli.script.Finder

findAllText, resetImage

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ImageFinder

public ImageFinder()

ImageFinder

public ImageFinder(Image base)

ImageFinder

public ImageFinder(IScreen scr)

ImageFinder

public ImageFinder(Region reg)

Method Detail

destroy

public void destroy()

Description copied from class: Finder

to explicitly free the Finder's resources

Overrides:

destroy in class Finder

setIsMultiFinder

public void setIsMultiFinder()

setImage

public boolean setImage(Image base)

isImage

public boolean isImage()

setScreen

public boolean setScreen(IScreen scr)

setRegion

public boolean setRegion(Region reg)

setFindTimeout

public void setFindTimeout(double t)

isValid

public boolean isValid()

Overrides:

isValid in class Finder

find

public String find(Image img)

Description copied from class: Finder

do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)

Overrides:

find in class Finder

Parameters:

img - Image

Returns:

null. if find setup not possible

find

public String find(String filenameOrText)

Description copied from class: Finder

do a find op with the given image or the given text in the Finder's image (hasNext() and next() will reveal possible match results)

Overrides:

find in class Finder

Parameters:

filenameOrText - image file name or text

Returns:

null. if find setup not possible

find

public String find(Pattern pat)

Description copied from class: Finder

do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)

Overrides:

find in class Finder

Parameters:

pat - Pattern

Returns:

null. if find setup not possible

findText

public String findText(String text)

Description copied from class: Finder

do a text find with the given text in the Finder's image (hasNext() and next() will reveal possible match results)

Overrides:

findText in class Finder

Parameters:

text - text

Returns:

null. if find setup not possible

search

public <PSI> ImageFind search(PSI probe,
                              Object... args)

searchAny

public <PSI> ImageFind searchAny(PSI probe,
                                 Object... args)

searchSome

public <PSI> ImageFind searchSome(PSI probe,
                                  Object... args)

searchSome

public <PSI> ImageFind searchSome(PSI probe,
                                  int count,
                                  Object... args)

findAll

public String findAll(Image img)

Description copied from class: Finder

do a findAll op with the given image in the Finder's image (hasNext() and next() will reveal possible match results)

Overrides:

findAll in class Finder

Parameters:

img - Image

Returns:

null. if find setup not possible

findAll

public String findAll(String filenameOrText)

Description copied from class: Finder

do a findAll op with the given image or the given text in the Finder's image (hasNext() and next() will reveal possible match results)

Overrides:

findAll in class Finder

Parameters:

filenameOrText - iamge file name or text

Returns:

null. if find setup not possible

findAll

public String findAll(Pattern pat)

Description copied from class: Finder

do a find op with the given pattern in the Finder's image (hasNext() and next() will reveal possible match results)

Overrides:

findAll in class Finder

Parameters:

pat - Pattern

Returns:

null. if find setup not possible

searchAll

public <PSI> ImageFind searchAll(PSI probe,
                                 Object... args)

searchAll

public <PSI> ImageFind searchAll(PSI probe,
                                 int sorted,
                                 Object... args)

hasChanges

public boolean hasChanges(org.opencv.core.Mat current)

setMinChanges

public void setMinChanges(int min)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Match>

Overrides:

hasNext in class Finder

Returns:

true if Finder has a next match, false otherwise

next

public Match next()

Specified by:

next in interface Iterator<Match>

Overrides:

next in class Finder

Returns:

the next match or null

remove

public void remove()

Description copied from class: Finder

not used

Specified by:

remove in interface Iterator<Match>

Overrides:

remove in class Finder