最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

drawrectangle

カスタマイズ可能な四角形 ROI の作成

構文

roi = drawrectangle

roi = drawrectangle(ax)

roi = drawrectangle(___,Name,Value)

説明

roi = drawrectangle は Rectangle オブジェクトを作成し、現在の座標軸での対話形式による四角形の関心領域 (ROI) の描画を有効にします。

ROI を描画するには、ポインターをイメージ上に配置します。カーソルが花形に変わります。クリック アンド ドラッグして四角形 ROI を描画します。ROI の描画を終了するには、マウス ボタンを離します。キーボード ショートカットやコンテキスト メニュー オプションを含む ROI の使用方法の詳細については、ヒントを参照してください。

メモ

drawrectangle は Rectangle ROI オブジェクトを作成するための簡易関数です。Rectangle を呼び出して ROI オブジェクトを直接作成する場合、オブジェクト関数 draw を呼び出して ROI の対話形式による描画を有効にしなければなりません。一方、関数 drawrectangle は ROI オブジェクトを作成し、オブジェクト関数 draw を呼び出します。どちらの方法で ROI を作成する場合でも、オブジェクト プロパティ、オブジェクト関数、およびイベント通知を使用して、その外観や動作をカスタマイズします。これらの機能の使用方法の詳細については、ヒントを参照してください。

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

roi = drawrectangle(___,Name,Value) は、1 つ以上の名前と値のペアを使用して ROI の外観や動作を変更します。指定されていない名前と値のペアは既定値に設定されます。

例

入れ子の四角形 ROI の描画

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

imshow(imread('baby.jpg'))

ラベル 'OuterRectangle' の付いた赤い四角形 ROI を描画します。

r1 = drawrectangle('Label','OuterRectangle','Color',[1 0 0]);

別の四角形 ROI を描画します。このとき、描画領域を最初の四角形内の領域に制限します。

r2 = drawrectangle('Label','InnerRectangle','DrawingArea',r1.Position);

プログラムによる四角形 ROI の作成

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

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

名前付きパラメーターを使用して四角形の位置とサイズを指定し、イメージ上に四角形 ROI を描画します。また、この例では四角形のエッジがストライプ状のラインになるように指定しています。

h = drawrectangle('Position',[500,500,1000,1000],'StripeColor','r');

四角形 ROI イベントのリスナーの設定

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

I = imread('cameraman.tif');

イメージを表示します。

imshow(I); 

イメージ上に四角形 ROI を描画します。

roi = drawrectangle('Color','r');

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

入力引数

ax — ROI の親の座標軸

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

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

名前と値のペアの引数

オプションの引数 Name,Value のコンマ区切りペアを指定します。Name は引数名で、Value は対応する値です。Name は引用符で囲まなければなりません。Name1,Value1,...,NameN,ValueN のように、複数の名前と値のペアの引数を、任意の順番で指定できます。

例: roi = drawrectangle('LineWidth',5);

'AspectRatio' — 四角形の縦横比

非負の数値スカラー

四角形の縦横比。'AspectRatio' と、height/width として計算される非負の数値スカラーで構成されるコンマ区切りのペアとして指定します。ROI の描画またはサイズ変更を行うと、この値は自動的に変化します。

'Color' — ROI の色

blue (既定値) | ColorSpec 値

ROI の色。'Color' と MATLAB^® ColorSpec (Color Specification) 値で構成されるコンマ区切りのペアとして指定します。

例: 'green'

例: 'g'

例: [0 1 0]

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

ContextMenu オブジェクト

コンテキスト メニュー。'ContextMenu' と ContextMenu オブジェクトから構成されるコンマ区切りのペアとして指定します。この名前と値のペアを指定すると、ROI を右クリックしたときにカスタム コンテキスト メニューが表示されます。カスタム コンテキスト メニューを作成するには、関数 uicontextmenu を使用して ContextMenu オブジェクトを作成してから、コンテキスト メニュー プロパティを設定します。

'Deletable' — コンテキスト メニューを使用して対話的に ROI を削除可能

true (既定値) | false

コンテキスト メニューを使用して対話的に ROI を削除可能。'Deletable' と logical 値 true または false で構成されるコンマ区切りのペアとして指定します。値が true (既定の設定) の場合、コンテキスト メニューを使用して ROI を削除できます。このコンテキスト メニュー項目を無効にするには、'Deletable' を false に設定します。値を false に設定した場合でも、ROI のハンドルを入力として指定して関数 delete を呼び出すことによって、ROI を削除できます。

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

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

ROI を対話形式で配置できる座標軸の領域。'DrawingArea' と次の表のいずれかの値で構成されるコンマ区切りのペアとして指定します。

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

'FaceAlpha' — ROI 面の透明度

0.2 (既定値) | スカラー

ROI 面の透明度。'FaceAlpha' と [0,1] の範囲のスカラー値で構成されるコンマ区切りのペアとして指定します。値が 1 の場合、ROI 面は完全に不透明になります。値が 0 の場合、ROI 面は完全に透明になります。

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

true (既定値) | false

ROI 面でクリックをキャプチャ可能。'FaceSelectable' と値 true または false で構成されるコンマ区切りのペアとして指定します。true (既定の設定) の場合、ROI 面でクリックをキャプチャできます。false の場合、ROI 面でクリックをキャプチャできません。

'FixedAspectRatio' — 縦横比を一定に維持

false (既定値) | true

対話型の操作中に縦横比を一定に維持。'FixedAspectRatio' と論理値 true または false で構成されるコンマ区切りのペアとして指定します。true の場合、四角形の描画やサイズ変更を行うときに ROI の縦横比は維持されます。false (既定の設定) の場合、四角形の描画やサイズ変更を行うときに縦横比を変更できます。このプロパティの状態は、既定のコンテキスト メニューを使用して変更できます。

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

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

親の Children プロパティでの ROI ハンドルの可視性。'HandleVisibility' と次の表のいずれかの値で構成されるコンマ区切りのペアとして指定します。

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

'InteractionsAllowed' — ROI の対話性

'all' (既定値) | 'none' | 'translate'

ROI の対話性。'InteractionsAllowed' と次の表のいずれかの値で構成されるコンマ区切りのペアとして指定します。

値	説明
'all'	ROI は完全に対話形式で操作できます (既定の設定)。
'none'	ROI は対話形式で操作できず、ドラッグ ポイントが表示されません。
'translate'	ROI は描画領域内で平行移動できますが、形状の変更はできません。関数 drawPoint では、この値を使用できません。

'Label' — ROI ラベル

'' (既定値) | 文字ベクトル | string

ROI ラベル。'Label' と、文字ベクトルまたは string で構成されるコンマ区切りのペアとして指定します。既定の設定では、このプロパティは空の配列 ('') に設定され、ROI にはラベルがありません。

'LabelVisible' — ROI ラベルの可視性

'on' (既定値) | 'hover' | 'inside' | 'off'

ROI ラベルの可視性。'LabelVisible' と次のいずれかの値で構成されるコンマ区切りのペアとして指定します。

値	説明
'on'	ROI が表示されていて Label プロパティが空でない場合、ラベルは表示されます (既定の設定)。
'hover'	マウスのカーソルを ROI 上に置いている場合のみ、ラベルは表示されます。
'inside'	ラベルは、表示するための十分なスペースが ROI 内にある場合のみ、表示されます。
'off'	ラベルは表示されません。

'LineWidth' — ROI のエッジの幅

スクリーン ピクセルに対する点の数の 3 倍 (既定値) | 正の数値スカラー

ROI のエッジの幅。'LineWidth' とポイント単位の正の数値スカラーで構成されるコンマ区切りのペアとして指定します。既定値はスクリーン ピクセルに対する点の数の 3 倍です。

'Parent' — ROI の親

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

ROI の親。'Parent' と Axes または UIAxes オブジェクトから構成されるコンマ区切りのペアとして指定します。重要な制限など UIAxes で ROI を使用する方法の詳細は、App Designer を使って作成したアプリでの ROI の使用を参照してください。

'Position' — ROI の位置

1 行 4 列の配列

ROI の位置。'Position' と、[xmin, ymin, width, height] 形式の 1 行 4 列の配列から構成されるコンマ区切りのペアとして指定します。xmin と ymin は四角形の左上隅の位置を指定します。width と height は四角形の広がりを 2 次元で指定します。ROI を描画または移動すると、この値は自動的に変化します。

'Rotatable' — ROI の回転可能性

false (既定値) | true

ROI の回転可能性。'Rotatable' と論理値 true または false で構成されるコンマ区切りのペアとして指定します。値が false (既定の設定) の場合、四角形を回転できません。値が true の場合、コーナーにあるマーカーの近くをクリックして四角形を回転できます。

'RotationAngle' — 四角形の中心周りの角度

0 (既定値) | 非負の数値スカラー

四角形の中心周りの角度。'RotationAngle' と非負の数値スカラーで構成されるコンマ区切りのペアとして指定します。角度は時計回りの方向に度単位で測定します。ROI を描画または移動すると、このプロパティの値は自動的に変化します。RotationAngle の値は、Position の値には影響を与えません。Position プロパティは回転前の四角形を表します。四角形を回転した場合、Vertices プロパティを使用して回転後の四角形の位置を決定します。

'Selected' — ROI の選択状態

false (既定値) | true

ROI の選択状態。'Selected' と true または false から構成されるコンマ区切りのペアとして指定します。この値は対話形式で設定することもできます。たとえば、ROI をクリックすると、それが選択され、この値が true に設定されます。同様に、Ctrl キーを押しながら ROI をクリックすると、それが選択解除され、この値は false に設定されます。

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

'none' (既定値) | colorspec

選択したときの ROI の色。'SelectedColor' と MATLAB ColorSpec (Color Specification) から構成されるコンマ区切りのペアとして指定します。'SelectedColor' が 'none' に設定された場合、Color の値はすべての状態 (選択または未選択) の ROI の色を定義します。

例: 'green'

例: 'g'

例: [0 1 0]

'StripeColor' — ROI ストライプの色

'none' (既定値) | ColorSpec 値

ROI ストライプの色。'StripeColor と MATLAB ColorSpec (Color Specification) 値で構成されるコンマ区切りのペアとして指定します。'StripeColor' を指定した場合、ROI エッジはストライプ状になります。縞模様は、'Color' で指定した値とこの値の組み合わせで構成されます。

例: 'green'

例: 'g'

例: [0 1 0]

'Tag' — ROI に関連付けるタグ

文字ベクトル | string スカラー

ROI に関連付けるタグ。'Tag' と文字ベクトルまたは string スカラーで構成されるコンマ区切りのペアとして指定します。関数 findobj を使用してオブジェクトの階層内の ROI オブジェクトを見つけるには、このタグ値を使用します。

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

任意の MATLAB データ

ROI に関連付けるデータ。'UserData' と任意の MATLAB データから構成されるコンマ区切りのペアとして指定します。たとえば、スカラー、ベクトル、行列、cell 配列、string、文字配列、テーブル、または構造体を指定できます。MATLAB はこのデータを使用しません。

'Vertices' — ROI のエッジ上の点の位置

n 行 2 列の配列

ROI のエッジ上の点の位置。'Vertices' と n 行 2 列の配列から構成されるコンマ区切りのペアとして返されます。

このプロパティは読み取り専用です。

'Visible' — ROI の可視性

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

ROI の可視性。'Visible' と、'on' または 'off'、もしくは数値か logical の 1 (true) または 0 (false) で構成されるコンマ区切りペアとして指定します。値 'on' は true と等価であり、'off' は false と等価です。そのため、このプロパティの値は logical 値として使用できます。この値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として格納されます。

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

出力引数

roi — 四角形 ROI

images.roi.Rectangle オブジェクト

四角形 ROI。Rectangle オブジェクトとして返されます。

ヒント

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

  動作	キーボード ショートカット
  ROI の描画をキャンセルする。	Esc キーを押します。関数は Position フィールドが空の有効な ROI オブジェクトを返します。
  ROI をサイズ変更 (形状変更) する。	頂点にポインターを配置し、クリック アンド ドラッグします。四角形には、各コーナーと各辺の中点に頂点があります。サイズ変更中に縦横比を保持するには、Shift キーを押します。縦横比をロックするには、右クリック コンテキスト メニューの [縦横比を固定] を使用します。
  ROI を移動する。	ROI 上にポインターを配置します。ポインターが花形に変わります。ROI をクリック アンド ドラッグします。
  ROI を削除する。	ROI の任意の位置にポインターを配置し、右クリックします。コンテキスト メニューから [四角形の削除] を選択します。オブジェクト関数 delete を使用して ROI を削除することもできます。

• 関数 drawrectangle は Rectangle ROI オブジェクトを返します。作成後、オブジェクトの次の機能を使用して、ROI の外観や動作をカスタマイズします。

  • オブジェクト プロパティ — ROI オブジェクトは、その外観や動作を変更するプロパティをサポートしています。たとえば、roi の色を黄色に変更するには、その Color プロパティを roi.Color = 'yellow' と設定します。

  • オブジェクト関数 — ROI オブジェクトは ROI を操作する一連のオブジェクト関数をサポートしています。たとえば、ROI の作成後、MATLAB コマンド ラインを一時停止する場合は、オブジェクト関数 wait を呼び出します。

  • イベント通知 — ROI に対して移動またはクリックなどの特定のイベントが発生した場合に、ROI オブジェクトはコードに通知を行うことができます。このような通知を受け取るには、オブジェクト関数 addlistener を使用して特定のイベントに対する "リスナー" を設定します。リスナーで、'ROIMoved' などのイベントと、イベントの発生時に実行されるコールバック関数を指定します。ROI がリスナーを通じてアプリケーションに通知するとき、イベントに固有のデータを返します。たとえば、'ROIMoved' イベントの場合、ROI オブジェクトはその以前の位置と現在の位置を返します。

  イベント リスナーを AssistedFreehand オブジェクトと共に使用する例については、四角形 ROI イベントのリスナーの設定を参照してください。これらの機能の詳細については、Rectangle オブジェクトのドキュメンテーションを参照してください。

互換性の考慮事項

UIContextMenu の名前と値のペアの引数は推奨されません。

R2020a 以降は非推奨

R2020a 以降では、UIContextMenu の名前と値のペアの引数を使用してコンテキスト メニューを ROI オブジェクトに割り当てることは推奨されません。代わりに、ContextMenu の名前と値のペアの引数を使用します。値は同じです。

現時点では UIContextMenu の名前と値のペアの引数のサポートを削除する予定はありません。

参考

drawassisted | drawcircle | drawcrosshair | drawcuboid | drawellipse | drawfreehand | drawline | drawpoint | drawpolygon | drawpolyline | Rectangle

トピック

• App Designer を使って作成したアプリでの ROI の使用
• ROI の描画後の待機関数の使用

R2018b で導入

×

例を開く

この例の変更されたバージョンがシステム上にあります。代わりにこのバージョンを開きますか?

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