1. 概要
2. 画像認識の設定の大まかな流れ
3. 画像認識の設定を作成する
   1. 設定画面を開く
   2. テンプレート画像を設定する
   3. 識別キーを設定する
   4. 探索範囲を設定する
   5. テストを行いスコアを設定する
      1. スコアとは
      2. テストとは
      3. テストの実行
4. C#スクリプトで画像認識を実行する
5. ブロックマクロで画像認識を実行する
6. アクションマクロで画像認識を実行する
7. テンプレート画像の選択について
   1. 画像ファイルを選択
   2. クリップボードの画像を保存選択
   3. 撮影
   4. 画像を切り抜く
8. 特定のウィンドウで画像認識
   1. 検出するウィンドウの範囲にタイトルバーに含める
      1. どういう時に有効にするのか

画像認識はテンプレート画像に類似する画像が指定した探索範囲にあるかどうか探します。
画像認識の結果（スコア）が自分で指定したスコア以上の場合に類似するかどうかを判断します。
基本的に画像認識の設定はマクロ上で行わず専用の設定画面で行います。

画像認識はフルスクリーンモードでは正常に動作しません。
ウィンドウモード・ボーダレスモード（仮想フルスクリーン）で使用してください。

1. 画像認識の設定を作成する
2. テンプレート画像を設定する
3. 探索範囲を設定する
4. テストを行いスコア（類似度）を設定する

ホーム、もしくは左側のアイコンから「画像認識／設定」を開きます。

「新しい設定」をクリックします。設定が追加されると同時に設定画面が開きます。

初めにテンプレート画像を選択する必要があります。
テンプレート画像の選択方法には下記のようなものがあります。
具体的な説明についてはテンプレート画像の選択についてを見てください。

お好きな方法でテンプレート画像を作成・設定してください。

識別キーは画像認識の設定項目を識別するための文字であり、画像認識を実行する際に使用されます。
テンプレート画像を選択すると、テンプレート画像のファイル名が識別キーになります。
変える必要は基本ありませんが、他の設定の識別キーと重複する場合は変えてください。

設定方法には以下のようなものがあります。

画像認識処理は範囲が広いほど時間がかかります。
そのため、テンプレート画像周辺だけで十分な場合は、画像より一回り大きい範囲を設定するといいでしょう。

スコアとは画像認識の結果の数値（スコア）のことを指します。
スコアがどの程度の数値になれば類似画像として認識するのかを決める基準値のことです。

テストでは画像認識を一度実行し、スコアがどれだけでるのかを確認することができます。

テストにはいくつか実行方法がありますが、ここでは「画像を撮影してテストを実行」の解説を行います。

「画像を撮影してテストを実行」をクリックすると、画像認識のテストに使用する画像を記録するためのウィンドウが開きます。
記録の準備ができたら「記録を開始」もしくは、ショートカットキー「Pause」を押して記録を開始します。
また、「記録を停止」もしくは、ショートカットキー「Pause」を押して記録を終了します。

記録が終了するとテスト用のウィンドウが表示されます。
ウィンドウの内容をざっくり説明しますと以下のとおりです。

1. 記録した画像が表示されます。
2. スライダーやボタンで記録した画像を変更することができます。
3. 画像認識の設定／実行を行うことができます。
4. 画像認識の実行後、スコアが表示されます。

とりあえず、画像認識を実行してみてください。

テンプレート画像が見つかれば、結果（スコア）が右下に表示されます。

表示されたスコアを見て目的の画像だけが認識されるように設定のスコアを調整します。
スコアは 0.0 ～ 1.0 の範囲で 1.0 に近いほどテンプレート画像との類似性が高いことを示します。
画像のように「0.9」と設定した場合は「0.9 以上」だった場合に類似画像としてみなされます。

もしテンプレート画像と違うものが認識されたり、想定していた画像が認識しなかった場合は、スコアを調整した後に再度実行してみてください。
なお、検出方法によって設定するスコアが変わりますのでご注意ください（詳しくはスコアの横にあるアイコンから）
⚠️ テストウィンドウでの設定は画像認識の設定へ反映されます。

これで画像認識の設定は以上になります。
次はマクロで画像認識を実行する方法について紹介します。

スクリプトエディタ上でCtrl+Tでテンプレート挿入機能を使いtmdと検索して画像認識を実行するコードを挿入します。

if (Match("識別キー", out var result))
{
    Console.WriteLine(result.X);
    Console.WriteLine(result.Y);
    Console.WriteLine(result.Score);
    Move(result.X, result.Y, 0);
}
else
{
    Console.WriteLine("画像は見つかりませんでした。");
}

複数の画像を見つけたい場合はtmsdと検索します。

if (Matches("識別キー", out var results))
{
    foreach (var result in results)
    {
        Console.WriteLine(result.X);
        Console.WriteLine(result.Y);
        Console.WriteLine(result.Score);
        Move(result.X, result.Y, 200);
    }
}
else
{
    Console.WriteLine("画像は見つかりませんでした。");
}

右側のツールボックスから「画像認識」を選択し、テンプレートをワークスペース内にドラッグアンドドロップします。

アクションリストで右クリック「テンプレートを追加する」>「画像認識：一つだけ探す」>「末尾に追加」をクリックすると画像認識のテンプレートが追加されます。

アクションリストで右クリック「テンプレートを追加する」>「画像認識：複数探す」>「末尾に追加」をクリックすると画像認識のテンプレートが追加されます。

ファイル選択ダイアログから画像を選択します。
既に画像ファイルがある場合はこちらを使用するといいでしょう。

Win+Shift+S を押すことで、任意の範囲を撮影することができます。
撮影を行うと、撮影された画像はクリップボードへコピーされます。
コピーした画像を「クリップボードの画像を保存+選択」をクリックすることでテンプレート画像として使うことができます。

「撮影」をクリックすると赤い枠のウィンドウが表示されます。
撮影したい範囲にサイズを調整してEnter キーを押すことで撮影・保存を行うことができます。

この機能を使用する場合は、事前に画像を用意するか、Windows の機能を使ってスクリーンショットを行いクリップボードへ画像をコピーしておく必要があります。

スクリーンショットは以下の方法で実行してください。

「画像を切り抜く」をクリックすると画像を切り抜くためのウィンドウが表示されます。

初めに、左上の「画像」から画像を読み込みます。

この画面では次の操作を行うことができます。

マウスの左ボタンをドラッグすることで画像の一部分を切り抜くことができます。

「テンプレート画像として使う」をクリックすると切り抜いた画像の保存とテンプレート画像への設定を行うことができます。

画像認識はメインディスプレイの左上を原点(0,0)として実行されます。
しかしウィンドウが移動してしまう設定されていた座標と範囲から外れることがあり、その都度、座標と範囲を設定し直す必要があります。
それは面倒であるためウィンドウの左上を原点にすることも可能にしてあります。

プロセス名（ウィンドウのタイトルでも設定可）を指定することで、KeyToKey は画像認識実行時にそのプロセスがもつウィンドウを探し、ウィンドウの左上を画像認識の原点にすることができます。

プロセス名には下記の条件の組み合わせを設定することができます。
これらは「プロセス・ウィンドウを指定」ボタンから設定することができます。

プロセス名に関してはプロセス名の名前を直接指定することができますが、プロセス名の部分一致やウィンドウのタイトルを指定する場合は次のようなjsonを指定する必要があります。
なお「プロセス・ウィンドウを指定」を使うと自動でjsonが指定されます。

{ "Text": "KeyToKey", "Target": 1, "Method": 0 }

一つのプロセスが複数のウィンドウを持っている場合は、ウィンドウタイトルを設定することを推奨します。

プロセス名を指定すると「検出するウィンドウの範囲にタイトルバーに含める」を有効にすることができます。
上の方でプロセス名が指定されてあると、そのプロセスのもつウィンドウの左上が原点になると説明しましたが、これは少々正しくない説明です。
正しくは、タイトルバーを含まないウィンドウ（クライアント領域）の左上が原点になります。

「座標と範囲」の機能である「画像から座標と範囲を選択」を使用する時に有効にします。
例えば、Alt+PrintScreen でアクティブウィンドウのスクリーンショットを撮影し、スクリーンショットを使って座標と範囲を設定すると画像認識実行時に座標にズレが生じます。
何故かというと、Alt+PrintScreen のスクリーンショットにはタイトルバーが含まれているためです（通常はタイトルバーを除いたクライアント座標が原点になるため）
このオプションを有効にすることで、座標のズレを修正することができます。
⚠️ KeyToKeyのようにウィンドウにタイトルバーがそもそも含まれてないアプリもあるので、そういった場合は有効にする必要はありません。