十字形

十字の関心領域

説明

Crosshair オブジェクトは、十字の関心領域 (ROI) の位置を指定します。この ROI に対し、外観や対話型動作をカスタマイズできます。

キーボード ショートカットを含むこの ROI の使用方法の詳細については、ヒントを参照してください。

作成

Crosshair オブジェクトは次の 2 つの方法で作成できます。詳細については、ROI の形状の作成を参照してください。

• 関数 drawcrosshair を使用。ROI の作成と外観の設定を 1 つのコマンドで行う場合、この関数を使用します。ROI の位置は、マウスを使ってイメージの上に ROI を描画することで対話形式で指定することも、名前と値の引数を使用してプログラムで指定することもできます。

• ここで説明する関数 images.roi.Crosshair を使用。ROI の位置を指定する前に ROI の外観や動作を指定する場合、この関数を使用します。位置は、オブジェクトを作成した後に、関数 draw を使用して対話形式で指定するか、オブジェクトのプロパティを変更してプログラムで指定することができます。

構文

roi = images.roi.Crosshair

roi = images.roi.Crosshair(ax)

roi = images.roi.Crosshair(___,PropertyName=Value)

説明

roi = images.roi.Crosshair は、既定のプロパティを使用して Crosshair オブジェクトを作成します。

roi = images.roi.Crosshair(ax) は、ax で指定される座標軸に ROI を作成します。

roi = images.roi.Crosshair(___,PropertyName=Value) は、名前と値の引数を使用して ROI のプロパティを設定します。複数の名前と値の引数を指定できます。

例: images.roi.Crosshair(Color="y") は、黄色の Crosshair オブジェクトを作成します。

入力引数

ax — ROI の親

gca (既定値) | Axes オブジェクト | UIAxes オブジェクト

ROI の親。Axes オブジェクトまたは UIAxes オブジェクトとして指定します。重要な制限など UI 座標軸で ROI を使用する方法の詳細については、App Designer を使って作成したアプリでの ROI の使用を参照してください。

プロパティ

形状と位置

Position — ROI の位置

1 行 2 列の数値ベクトル

ROI の位置。[x y] 形式の 1 行 2 列の数値ベクトルとして指定します。値 x と y は、十字 ROI の水平線が垂直線と交差する位置の x 座標と y 座標を指定します。ROI を描画または移動すると、この値は自動的に変化します。

色とスタイル

Color — ROI の色

[0 0.4470 0.7410] (既定値) | RGB 3 成分 | 色名 | 色の省略名

ROI の色。RGB 3 成分、色の名前、または色の省略名として指定します。

RGB 3 成分を使用すると、任意の色を指定できます。RGB 3 成分は、色の赤、緑、青の成分の強度を指定する 3 つの要素から成る行ベクトルです。強度は [0, 1] の範囲でなければなりません。

いくつかの一般的な色については、色の名前を string スカラーまたは文字ベクトルとして指定できます。次の表に、名前付きの色のオプション、およびそれと等価な RGB 3 成分を示します。

色名	省略名	RGB 3 成分	外観
"red"	"r"	[1 0 0]
"green"	"g"	[0 1 0]
"blue"	"b"	[0 0 1]
"cyan"	"c"	[0 1 1]
"magenta"	"m"	[1 0 1]
"yellow"	"y"	[1 1 0]
"black"	"k"	[0 0 0]
"white"	"w"	[1 1 1]

次の表に、ライト テーマとダーク テーマにおけるプロットの既定のカラー パレットを示します。

パレット	パレット カラー
"gem" — ライト テーマの既定 R2025a より前: ほとんどのプロットでは既定でこれらの色が使用されます。
"glow" — ダーク テーマの既定

orderedcolors 関数を使用して、これらのパレットの RGB 3 成分を取得できます (R2023b 以降)。たとえば、"gem" パレットの RGB 3 成分を取得します。

RGB = orderedcolors("gem");

例: Color="r"

例: Color="green"

例: Color=[0 0.4470 0.7410]

LineWidth — ROI の境界線の幅

正の数値

ROI の境界線の幅。ポイント単位の正の数値として指定します。既定値はスクリーン ピクセルに対する点の数の 3 倍です。つまり、既定では境界線の幅は 3 ピクセルになります。

SelectedColor — 選択したときの ROI の色

"none" (既定値) | RGB 3 成分 | 色名 | 色の省略名

選択したときの ROI の色。RGB 3 成分、色の名前、色の省略名、または "none" として指定します。"none" を指定した場合、Color の値はすべての状態 (選択または未選択) の ROI の色を定義します。

RGB 3 成分を使用すると、任意の色を指定できます。RGB 3 成分は、色の赤、緑、青の成分の強度を指定する 3 つの要素から成る行ベクトルです。強度は [0, 1] の範囲でなければなりません。

いくつかの一般的な色については、色の名前を string スカラーまたは文字ベクトルとして指定できます。次の表に、名前付きの色のオプション、およびそれと等価な RGB 3 成分を示します。

色名	省略名	RGB 3 成分	外観
"red"	"r"	[1 0 0]
"green"	"g"	[0 1 0]
"blue"	"b"	[0 0 1]
"cyan"	"c"	[0 1 1]
"magenta"	"m"	[1 0 1]
"yellow"	"y"	[1 1 0]
"black"	"k"	[0 0 0]
"white"	"w"	[1 1 1]

次の表に、ライト テーマとダーク テーマにおけるプロットの既定のカラー パレットを示します。

パレット	パレット カラー
"gem" — ライト テーマの既定 R2025a より前: ほとんどのプロットでは既定でこれらの色が使用されます。
"glow" — ダーク テーマの既定

orderedcolors 関数を使用して、これらのパレットの RGB 3 成分を取得できます (R2023b 以降)。たとえば、"gem" パレットの RGB 3 成分を取得します。

RGB = orderedcolors("gem");

例: SelectedColor="r"

例: SelectedColor="green"

例: SelectedColor=[0 0.4470 0.7410]

StripeColor — ROI ストライプの色

"none" (既定値) | RGB 3 成分 | 色名 | 色の省略名

ROI ストライプの色。RGB 3 成分、色の名前、色の省略名、または "none" として指定します。"none" を指定した場合、ROI のエッジは Color で指定された単色になります。そうでない場合、ROI のエッジはストライプ状になります。このとき、Color および StripeColor で指定された色が交互に現れます。

RGB 3 成分を使用すると、任意の色を指定できます。RGB 3 成分は、色の赤、緑、青の成分の強度を指定する 3 つの要素から成る行ベクトルです。強度は [0, 1] の範囲でなければなりません。

いくつかの一般的な色については、色の名前を string スカラーまたは文字ベクトルとして指定できます。次の表に、名前付きの色のオプション、およびそれと等価な RGB 3 成分を示します。

色名	省略名	RGB 3 成分	外観
"red"	"r"	[1 0 0]
"green"	"g"	[0 1 0]
"blue"	"b"	[0 0 1]
"cyan"	"c"	[0 1 1]
"magenta"	"m"	[1 0 1]
"yellow"	"y"	[1 1 0]
"black"	"k"	[0 0 0]
"white"	"w"	[1 1 1]

次の表に、ライト テーマとダーク テーマにおけるプロットの既定のカラー パレットを示します。

パレット	パレット カラー
"gem" — ライト テーマの既定 R2025a より前: ほとんどのプロットでは既定でこれらの色が使用されます。
"glow" — ダーク テーマの既定

orderedcolors 関数を使用して、これらのパレットの RGB 3 成分を取得できます (R2023b 以降)。たとえば、"gem" パレットの RGB 3 成分を取得します。

RGB = orderedcolors("gem");

例: StripeColor="r"

例: StripeColor="green"

例: StripeColor=[0 0.4470 0.7410]

Visible — ROI の可視性

"on" (既定値) | "off" | on/off の logical 値

ROI の可視性。"on" か "off"、または数値か logical の 0 (false) か 1 (true) として指定します。"on" の値は true と等価であり、"off" は false と等価です。この値は、OnOffSwitchState 型の on/off の logical 値として格納されます。

値	説明
"on"	ROI を表示します。
"off"	ROI を削除せずに非表示にします。ただし、非表示の ROI のプロパティにアクセスすることはできます。

ラベル

Label — ROI ラベル

'' (既定値) | 文字ベクトル | string スカラー

ROI ラベル。文字ベクトルまたは string スカラーとして指定します。既定では、ROI にラベルはありません ('')。

LabelAlpha — テキストの背景の透明度

1 (既定値) | 範囲 [0, 1] の数値

テキストの背景の透明度。[0, 1] の範囲の数値として指定します。1 に設定すると、テキストの背景は完全に不透明になります。0 に設定すると、テキストの背景は完全に透明になります。

LabelTextColor — ラベル テキストの色

"black" (既定値) | RGB 3 成分 | 色名 | 色の省略名

ラベル テキストの色。RGB 3 成分、色の名前、または色の省略名として指定します。

RGB 3 成分を使用すると、任意の色を指定できます。RGB 3 成分は、色の赤、緑、青の成分の強度を指定する 3 つの要素から成る行ベクトルです。強度は [0, 1] の範囲でなければなりません。

いくつかの一般的な色については、色の名前を string スカラーまたは文字ベクトルとして指定できます。次の表に、名前付きの色のオプション、およびそれと等価な RGB 3 成分を示します。

色名	省略名	RGB 3 成分	外観
"red"	"r"	[1 0 0]
"green"	"g"	[0 1 0]
"blue"	"b"	[0 0 1]
"cyan"	"c"	[0 1 1]
"magenta"	"m"	[1 0 1]
"yellow"	"y"	[1 1 0]
"black"	"k"	[0 0 0]
"white"	"w"	[1 1 1]

次の表に、ライト テーマとダーク テーマにおけるプロットの既定のカラー パレットを示します。

パレット	パレット カラー
"gem" — ライト テーマの既定 R2025a より前: ほとんどのプロットでは既定でこれらの色が使用されます。
"glow" — ダーク テーマの既定

orderedcolors 関数を使用して、これらのパレットの RGB 3 成分を取得できます (R2023b 以降)。たとえば、"gem" パレットの RGB 3 成分を取得します。

RGB = orderedcolors("gem");

例: LabelTextColor="r"

例: LabelTextColor="green"

例: LabelTextColor=[0 0.4470 0.7410]

LabelVisible — ラベルの可視性

"on" (既定値) | "off" | "hover"

ラベルの可視性。次のいずれかの値として指定します。

値	説明
"on"	ROI が表示されている場合、ラベルは表示されます。
"hover"	マウスのカーソルを ROI 上に置いている場合のみ、ラベルは表示されます。
"off"	ラベルは表示されません。

対話性

ContextMenu — コンテキスト メニュー

ContextMenu オブジェクト

ROI を右クリックしたときに表示されるコンテキスト メニュー。ContextMenu オブジェクトとして指定します。関数 uicontextmenu を使用してコンテキスト メニュー プロパティを設定することによって、カスタム コンテキスト メニューを作成できます。

Deletable — ROI を削除するオプションをコンテキスト メニューに表示するかどうか

true または 1 (既定値) | false または 0

ROI を削除するオプションをコンテキスト メニューに表示するかどうか。数値または logical の 1 (true) か 0 (false) として指定します。値が true の場合、コンテキスト メニューを使用して ROI を対話形式で削除できます。値が false の場合、ROI を削除するコンテキスト メニュー オプションは無効になります。

どちらの場合も、コンテキスト メニューではなく関数 delete を使用して ROI を削除できます。

DrawingArea — ROI を対話形式で配置できる座標軸の領域

"auto" (既定値) | "unlimited" | [x,y,w,h]

ROI を対話形式で配置できる座標軸の領域。次の表のいずれかの値で指定します。

値	説明
"auto"	描画領域は現在の座標軸の範囲です (既定の設定)。
"unlimited"	描画領域には境界がなく、座標軸の範囲を超えて ROI を描画したりドラッグしたりできます。
[x,y,w,h]	描画領域は、(x,y) を基準として幅 w と高さ h まで広がる四角形の領域に制限されます。

InteractionsAllowed — ROI の対話性

"all" (既定値) | "none"

ROI の対話性。次の表のいずれかの値で指定します。

値	説明
"all"	ROI は完全に対話形式で操作できます。
"none"	ROI は対話形式で操作できず、ドラッグ ポイントが表示されません。

Selected — ROI の選択状態

false、0、または "off" (既定値) | true、1、または "on"

ROI の選択状態。"off" か "on"、または数値か logical の 0 (false) か 1 (true) として指定します。"off" の値は false と等価であり、"on" は true と等価です。

このプロパティは対話形式で設定することもできます。たとえば、ROI をクリックすると、その ROI が選択され、このプロパティが true に設定されます。同様に、Ctrl キーを押したまま ROI をクリックすると、ROI は選択解除され、このプロパティの値が false に設定されます。

親/子

HandleVisibility — 親の Children プロパティでの ROI ハンドルの可視性

"on" (既定値) | "off" | "callback"

親の Children プロパティでの ROI ハンドルの可視性。次の表のいずれかの値として指定します。

値	説明
"on"	オブジェクト ハンドルは常に参照できます (既定の設定)。
"off"	オブジェクト ハンドルは常に参照できません。
"callback"	オブジェクト ハンドルはコールバックまたはコールバックによって呼び出された関数内から参照できますが、コマンド ラインから呼び出された関数内からは参照できません。

Parent — ROI の親

Axes オブジェクト | UIAxes オブジェクト

ROI の親。Axes または UIAxes オブジェクトとして指定します。重要な制限など UI 座標軸で ROI を使用する方法の詳細については、App Designer を使って作成したアプリでの ROI の使用を参照してください。

識別子

Tag — ROI に関連付けるタグ

'' (既定値) | 文字ベクトル | string スカラー

ROI に関連付けるタグ。文字ベクトルまたは string スカラーとして指定します。関数 findobj を使用してオブジェクトの階層内の ROI オブジェクトを見つけるには、このタグ値を使用します。

UserData — ROI に関連付けるデータ

任意の MATLAB^® データ

ROI に関連付けるデータ。任意の MATLAB データとして指定します。たとえば、スカラー、ベクトル、行列、cell 配列、string、文字配列、table、または構造体を指定できます。十字形 オブジェクトはこのデータを使用しません。

オブジェクト関数

addlistener	イベント ソースにバインドされたイベント リスナーの作成
beginDrawingFromPoint	指定された点からの ROI の描画の開始
bringToFront	Axes のスタックの順番の最前面への ROI の移動
draw	対話形式による ROI の描画の開始
wait	ROI の操作が完了するまで MATLAB コマンド ラインをブロック

例

十字 ROI の作成

イメージをワークスペースに読み取って表示します。

I = imread('baby.jpg');
figure;
imshow(I)

プログラムによって十字 ROI をイメージ上に配置します。ROI の位置を指定する場合、座標軸を指定しなければなりません。

h = images.roi.Crosshair(gca,'Position',[100,100]);

ピクセル値をチェックするための十字ツールの作成

イメージをワークスペースに読み取ります。

img = imread("coins.png");

イメージを Figure に表示します。

figure
hAx = gca;
imObj = imshow(img,Parent=hAx);
imObj.Parent.Visible = "on";

イメージに関連付けられた十字 ROI を作成します。十字の位置がまだ設定されていないため、イメージ上に十字は表示されません。

h = images.roi.Crosshair(Parent=hAx,LineWidth=1,Color="y");

イメージ上で ROI が移動したときに通知を取得するようにリスナーを設定します。次のコードは十字の下にあるピクセルの値を表示するので、イメージを引数としてリスナーに渡さなければなりません。

addlistener(h,MovingROI=@(src,data)displayInfo(src,data,hAx,img));

対話形式で ROI の描画を開始します。十字を配置した後は、新しい位置にドラッグできます。Figure のタイトルは、十字の中心にあるピクセルの値で更新されます。

draw(h)

次の図に、十字 ROI を対話的に移動するときのタイトル付きイメージの外観サンプルを示します。

MovingROI イベントが発生したときにリスナーによって呼び出される関数 displayInfo を定義します。

function displayInfo(~,data,hAx,img)
    pos = ceil(data.CurrentPosition);
    title(hAx,"Pixel Value: "+num2str(img(pos(2),pos(1))))
end

詳細

イベント

特定のイベントが発生したときに ROI から通知を受け取るには、これらのイベントに対する "リスナー" を設定します。これらのイベントのいずれかが発生したときに実行するコールバック関数を指定できます。ROI がリスナーを通じてアプリケーションに通知するとき、イベントに固有のデータを返します。特定のイベントのイベント クラスを確認して何が返されたかを調べます。

イベント リスナーの使用例については、ピクセル値をチェックするための十字ツールの作成を参照してください。

イベント名	トリガー	イベント データ	イベント属性
DeletingROI	ROI が対話的に削除されようとしている。	event.EventData	NotifyAccess: private ListenAccess: public
DrawingStarted	ROI が対話的に描画されようとしている。	event.EventData	NotifyAccess: private ListenAccess: public
DrawingFinished	ROI が対話的に描画された。	event.EventData	NotifyAccess: private ListenAccess: public
MovingROI	ROI の形状または位置が対話的に変更中である。	images.roi.ROIMovingEventData	NotifyAccess: private ListenAccess: public
ROIMoved	ROI の形状または位置が対話的に変更された。	images.roi.ROIMovingEventData	NotifyAccess: private ListenAccess: public
ROIClicked	ROI がクリックされた。	images.roi.ROIClickedEventData	NotifyAccess: private ListenAccess: public

ヒント

• 関数 draw または drawcrosshair を使用して対話形式で ROI を描画するには、カーソルをイメージ上に配置し、マウスをクリックして ROI を描画します。

• ROI は、キーボード ショートカットを含む以下の対話性をサポートします。

  タスク	説明
  描画操作をキャンセルする。	Esc キーを押します。関数は Position プロパティが空の有効な ROI オブジェクトを返します。
  ROI を移動する。	カーソルを十字 ROI の中心 (2 本のラインが交差する位置) に配置し、十字をクリック アンド ドラッグします。十字 ROI を移動するもう 1 つの方法は、2 本のラインのいずれかの上で任意の位置にカーソルを配置してクリックすることです。十字の他方のラインが十字の新しい中心位置にジャンプします。
  ROI を削除する。	カーソルを ROI 上に配置し、右クリックして表示されたコンテキスト メニューから [十字形の削除] を選択します。関数 delete を使用して、プログラムによって ROI を削除することもできます。

• App Designer を使って作成したアプリで ROI を使用する方法の詳細については、App Designer を使って作成したアプリでの ROI の使用を参照してください。

バージョン履歴

R2019b で導入

R2020a: UIContextMenu プロパティは推奨されません

R2020a 以降では、UIContextMenu プロパティを使用してコンテキスト メニューをグラフィックス オブジェクトや UI コンポーネントに割り当てることは推奨されません。代わりに ContextMenu プロパティを使用してください。プロパティの値は同じです。

現時点では UIContextMenu プロパティのサポートを削除する予定はありません。ただし、グラフィックス オブジェクトまたは UI コンポーネントに対して関数 get を呼び出すことにより返されるリストに、UIContextMenu プロパティは表示されなくなりました。

参考

drawcrosshair | Line | Point | Polyline

トピック

• ROI の形状の作成