AssistedFreehand

補助付きフリーハンドの関心領域

説明

AssistedFreehand オブジェクトは、手描きの関心領域 (ROI) の形状と位置を指定します。この ROI では、描画されたラインはベースのイメージ内のエッジに自動的に従います。この ROI に対し、外観や対話型動作をカスタマイズできます。

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

作成

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

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

• ここで説明する関数 images.roi.AssistedFreehand を使用。ROI の形状や位置を指定する前に ROI の外観や動作を指定する場合、この関数を使用します。形状と位置は、オブジェクトを作成した後に、関数 draw を使用して対話形式で指定できます。

構文

roi = images.roi.AssistedFreehand

roi = images.roi.AssistedFreehand(ax)

roi = images.roi.AssistedFreehand(___,Name,Value)

説明

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

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

roi = images.roi.AssistedFreehand(___,Name,Value) は、名前と値の引数を使用して ROI のプロパティを設定します。複数の名前と値の引数を指定できます。各プロパティ名を一重引用符で囲みます。

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

入力引数

ax — ROI の親

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

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

プロパティ

Closed — ROI を閉じるかどうか

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

ROI を閉じる。数値または logical の 1 (true) か 0 (false) として指定します。true の場合、AssistedFreehand オブジェクトは、描画された最後の点を描画された最初の点と結ぶことによって 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]

以下に、MATLAB^® がさまざまなタイプのプロットで使用する既定の色の RGB 3 成分を示します。

RGB 3 成分	外観
[0 0.4470 0.7410]
[0.8500 0.3250 0.0980]
[0.9290 0.6940 0.1250]
[0.4940 0.1840 0.5560]
[0.4660 0.6740 0.1880]
[0.3010 0.7450 0.9330]
[0.6350 0.0780 0.1840]

例: "Color","r"

例: "Color","green"

例: "Color",[0 0.4470 0.7410]

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 まで広がる四角形の領域に制限されます。

FaceAlpha — ROI 面の透明度

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

ROI 面の透明度。[0, 1] の範囲の数値として指定します。値が 1 の場合、ROI 面は完全に不透明になります。値が 0 の場合、ROI 面は完全に透明になります。

FaceSelectable — ROI 面でクリックをキャプチャ可能

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

ROI 面でクリックをキャプチャ可能。数値または logical の 1 (true) か 0 (false) として指定します。true の場合、ROI 面でマウス クリックをキャプチャします。false (既定の設定) の場合、ROI 面でマウス クリックをキャプチャしません。

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

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

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

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

Image — ROI を描画するイメージ

Image オブジェクト

ROI を描画するイメージ。Image オブジェクトとして指定します。

InteractionsAllowed — ROI の対話性

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

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

値	説明
"all"	ROI は完全に対話形式で操作できます (既定の設定)。
"none"	ROI は対話形式で操作できず、ドラッグ ポイントが表示されません。
"translate"	ROI は描画領域内で平行移動できますが、形状の変更はできません。
"reshape"	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]

以下に、MATLAB がさまざまなタイプのプロットで使用する既定の色の RGB 3 成分を示します。

RGB 3 成分	外観
[0 0.4470 0.7410]
[0.8500 0.3250 0.0980]
[0.9290 0.6940 0.1250]
[0.4940 0.1840 0.5560]
[0.4660 0.6740 0.1880]
[0.3010 0.7450 0.9330]
[0.6350 0.0780 0.1840]

例: "LabelTextColor","r"

例: "LabelTextColor","green"

例: "LabelTextColor",[0 0.4470 0.7410]

LabelVisible — ラベルの可視性

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

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

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

LineWidth — ROI の境界線の幅

正の数値

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

MarkerSize — マーカー サイズ

正の数値

マーカー サイズ。ポイント単位の正の数値として指定します。既定値はスクリーン ピクセルに対する点の数の 8 倍です。つまり、既定ではマーカー サイズは 8 ピクセルになります。

Parent — ROI の親

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

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

Position — ROI の位置

[] (既定値) | n 行 2 列の数値行列

ROI の位置。n 行 2 列の数値行列として指定します。ここで、n は ROI を定義する頂点または点の数です。各行は、頂点または点の [x y] 座標を表します。ROI の形状の対話形式による描画中に、AssistedFreehand オブジェクトがこれらの点を生成します。より少ない点を扱うには、関数 reduce を使用します。

Selected — ROI の選択状態

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

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

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]

以下に、MATLAB がさまざまなタイプのプロットで使用する既定の色の RGB 3 成分を示します。

RGB 3 成分	外観
[0 0.4470 0.7410]
[0.8500 0.3250 0.0980]
[0.9290 0.6940 0.1250]
[0.4940 0.1840 0.5560]
[0.4660 0.6740 0.1880]
[0.3010 0.7450 0.9330]
[0.6350 0.0780 0.1840]

例: "SelectedColor","r"

例: "SelectedColor","green"

例: "SelectedColor",[0 0.4470 0.7410]

Smoothing — ROI のエッジに適用する平滑化

1 (既定値) | 非負の数値

対話形式で配置した後の ROI のエッジに適用される平滑化。非負のスカラーとして指定します。AssistedFreehand オブジェクトは、既定の標準偏差 1 のガウス平滑化カーネルを使用して、ROI の x 座標と y 座標をフィルター処理します。ガウス フィルターのサイズは 2*ceil(2*Smoothing)+1 です。

描画を完了した後にのみ平滑化効果を確認できます。描画の完了後に Smoothing の値を変更しても ROI に影響を与えません。

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]

以下に、MATLAB がさまざまなタイプのプロットで使用する既定の色の RGB 3 成分を示します。

RGB 3 成分	外観
[0 0.4470 0.7410]
[0.8500 0.3250 0.0980]
[0.9290 0.6940 0.1250]
[0.4940 0.1840 0.5560]
[0.4660 0.6740 0.1880]
[0.3010 0.7450 0.9330]
[0.6350 0.0780 0.1840]

例: "StripeColor","r"

例: "StripeColor","green"

例: "StripeColor",[0 0.4470 0.7410]

Tag — ROI に関連付けるタグ

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

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

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

任意の MATLAB データ

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

Visible — ROI の可視性

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

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

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

Waypoints — 位置の点をウェイポイントとするかどうか

[] (既定値) | logical ベクトル

位置の点をウェイポイントとするかどうか。Position プロパティと同じ長さの logical ベクトルとして指定します。値が true である Waypoints の要素は、Position 行列の対応する点がウェイポイントであることを表しています。既定では、AssistedFreehand オブジェクトは、ROI を定義するすべての点を生成し、曲率が増加する位置にある点のみをウェイポイントにします。roi.Waypoints(1:4:end) = true; のようなコードを使用すると、すべての点または点のサブセットをウェイポイントにすることができます。

ウェイポイントは ROI エッジ上に円として表示されます。マウスでウェイポイントをクリック アンド ドラッグすることにより、ウェイポイントを使用して ROI の形状を変更できます。ウェイポイントを移動すると、クリックしたウェイポイントと隣接するウェイポイントの間のフリーハンドで描画した領域が変更されます。

オブジェクト関数

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

例

補助付きフリーハンドを使用したフリーハンド ROI の作成

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

figure
imshow(imread('baby.jpg'))

AssistedFreehand オブジェクトを作成し、ラインの色を指定します。既定では、このオブジェクトは現在の座標軸に ROI を作成します。座標軸にはイメージが含まれていなければならないことに注意してください。ROI の位置がまだ設定されていないため、イメージ上に ROI は表示されません。

roi = images.roi.AssistedFreehand(Color="y");

AssistedFreehand オブジェクトを引数として指定して、関数 draw を呼び出します。イメージの上にカーソルを移動するとポインターが十字に変わります。ROI の描画を続けることができます。ポインターを移動したときに、描画するラインがベースのイメージ内のエッジに従うことに注意してください。描画中にクリックして、エッジに沿って頂点を追加します。

draw(roi)

AssistedFreehand ROI イベントのリスナーの設定

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

I = imread('cameraman.tif');

イメージを表示します。表示されたイメージ オブジェクトを返す imshow 構文を使用します。

img = imshow(I);

イメージ上に AssistedFreehand ROI を作成します。オブジェクト関数 draw を呼び出して、対話形式による ROI の形状の描画を有効にします。ROI ラインがベースのイメージ内のエッジに自動的に従うことを確認してください。

roi = images.roi.AssistedFreehand(img);
draw(roi)

ROI 移動イベントのリスナーを設定します。移動すると、ROI は、それらのイベントの通知を送信し、指定されたコールバック関数を実行します。

addlistener(roi,'MovingROI',@allevents);
addlistener(roi,'ROIMoved',@allevents);

コールバック関数 allevents は ROI の以前の位置と現在の位置をコマンド ラインに表示します。

function allevents(src,evt)
    evname = evt.EventName;
    switch(evname)
        case{'MovingROI'}
            disp(['ROI moving previous position: ' mat2str(evt.PreviousPosition)]);
            disp(['ROI moving current position: ' mat2str(evt.CurrentPosition)]);
        case{'ROIMoved'}
            disp(['ROI moved previous position: ' mat2str(evt.PreviousPosition)]);
            disp(['ROI moved current position: ' mat2str(evt.CurrentPosition)]);
    end
end

詳細

イベント

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

例については、AssistedFreehand 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
AddingWaypoint	ウェイポイントが ROI に対話的に追加されようとしている。	event.EventData	NotifyAccess: private ListenAccess: public
WaypointAdded	ウェイポイントが ROI に対話的に追加された。	event.EventData	NotifyAccess: private ListenAccess: public
RemovingWaypoint	ウェイポイントが ROI から対話的に削除されようとしている。	event.EventData	NotifyAccess: private ListenAccess: public
WaypointRemoved	ウェイポイントが ROI から対話的に削除された。	event.EventData	NotifyAccess: private ListenAccess: public

ヒント

• 関数 draw または drawassisted を使用して対話形式で ROI を描画するには、ポインターをイメージに配置し、クリック アンド リリースして最初の頂点 (ウェイポイント) を配置します。次に、ポインターを移動してラインを描画します。描画中に、ラインはイメージ内のオブジェクトのエッジに自動的に従います。ROI の描画を完了するには、ダブルクリックします。

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

  動作	キーボード ショートカット
  ROI の描画をキャンセルする。	Esc キーを押します。関数は Position プロパティが空の有効な ROI オブジェクトを返します。
  ROI の描画を終了する (閉じる)。	ダブルクリックします。これにより、ポインターの位置に点が追加され、描画した最初の点にこの点をつなぐラインが描画され、ROI が閉じます。 右クリックします。これにより、描画した最初の点に最後の点をつなぐラインが描画されます。 最初の点にポインターを配置して、クリックします。 Enter キーを押します。これにより、描画した最初の点に最後の点をつなぐラインが描画されます。
  ROI をサイズ変更 (形状変更) する。	ウェイポイントにポインターを配置し、クリック アンド ドラッグします。このモードでは補助機能 (エッジへのスナッピング) を使用できません。
  ウェイポイントを追加する。	ROI のエッジにポインターを配置し、右クリックして [ウェイポイントの追加] を選択します。ROI のエッジにポインターを配置し、ダブルクリックすることもできます。
  ウェイポイントを削除する。	ウェイポイントにポインターを配置し、右クリックして [ウェイポイントの削除] を選択します。
  ROI を移動する。	ROI 上にポインターを配置します。ポインターが花形に変わります。クリック アンド ドラッグして ROI を移動します。
  ROI を削除する。	ポインターを (頂点上ではなく) ROI 上に配置し、右クリックして表示されたコンテキスト メニューから [フリーハンドの削除] を選択します。関数 delete を使用して、プログラムによって ROI を削除することもできます。

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

バージョン履歴

R2018b で導入

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

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

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

参考

drawassisted | Freehand | Polygon | Polyline

トピック

• ROI の形状の作成

×

例を開く

この例の変更されたバージョンがあります。編集された方の例を開きますか?

いいえ、変更されたバージョンを上書きします。 はい