Sikuli - 画像マッチングメソッド一覧

Sikuliでは画像マッチングで処理を行うのが基本となります。
そのため画像マッチングに関するメソッドを一通り把握しておくのはとても重要です。

画像マッチングのメソッド一覧は下記の通りです。
(PSはPatternオブジェクト、Stringオブジェクトを表します。)

画像マッチングのメソッド一覧

メソッド 説明
find(PS) 領域内から、最も類似度が高い部分をMatchオブジェクトとして返す。
findAll(PS) 領域内から、合致する全ての部分をMatchオブジェクトのリストとして返す。
wait(PS, seconds) PSが登場するまでseconds秒待つ。
watiVanish(PS, seconds) PSが消えるまでseconds秒待つ。
exists(PS, seconds) 画像が存在するかどうかを調べる。seconds秒待ち、見つからない場合は例外を発生する。
has(PS, seconds) existsと同じだが、見つからないときに例外を発生しない。
findBest(PS, PS, …) 複数の画像マッチ条件を引数に設定し、もっとも類似度が高いものを返す。
findBestList(ListPS) 上記と同じ動作をするが、引数をリストとして渡す。
findAny(PS, PS, …) 複数の画像マッチ条件を引数に設定し、条件を満たすものを全て返す。
findAny(ListPS) 上記と同じ動作をするが、引数をリストとして渡す。
setImageMissingHandler
(function_name)
画像が存在しなかった時に実行するコールバック関数を設定する。
setFindFailedResponse
(ABOART|SKIP|PROMPT|RETRY)
画像が見つからなかった時にどうするかを設定する。
 ABORT:処理を終了する。
 SKIP:処理をスキップする。
 RETRY:リトライする。
 PROMPT:ダイアログボックスを表示しユーザに選択させる。
setFindFailedHandler(function_name) 画像が見つからなかったときに実行するコールバック関数を設定する。
getFindFailedResponse setFindFailedResponseの現在の値を返す。
setThrowException(False|True) 画像が見つからなかった時に例外を発生するかどうかを設定する。