このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

Ellipse

楕円の関心領域

説明

Ellipse は楕円の関心領域 (ROI) オブジェクトです。

ROI を描画するには、カーソルを座標軸に配置し、クリック アンド ドラッグして形状を作成します。ROI の描画を終了するには、マウス ボタンを離します。キーボード ショートカットを含むこの ROI の使用方法の詳細については、ヒントを参照してください。

円 ROI を描画するには、Circle オブジェクトを使用します。

作成

説明

Ellipse オブジェクトを作成するには、作成関数 images.roi.Ellipse を使用します。オブジェクトを作成した後、オブジェクト関数 draw を呼び出して描画を開始します。便宜上、関数 drawellipse を使用して Ellipse ROI を作成することもできます。関数 drawellipse は ROI オブジェクトを作成し、オブジェクト関数 draw を呼び出します。

roi = images.roi.Ellipse は、既定のプロパティを使用して images.roi.Ellipse クラスのインスタンスを作成します。

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

roi = images.roi.Ellipse(___,Name,Value) は、名前と値のペアを使用してプロパティを設定します。たとえば、images.roi.Ellipse('Color','y') は Ellipse オブジェクトの色を黄色に設定します。複数の名前と値のペアを指定できます。各プロパティ名を一重引用符で囲みます。

入力引数

ax — ROI の親

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

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

プロパティ

AspectRatio — 楕円の縦横比

(1+sqrt(5))/2 (既定値) | 正の数値スカラー

楕円の縦横比。数値スカラーを指定します。このプロパティの値は、楕円の描画やサイズ変更を行ったり SemiAxes プロパティを設定したりすると自動的に変化します。images.roi.Ellipse オブジェクトは、この値を height/width として計算します。

Center — ROI の中心

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

ROI の中心。[x y] 形式の 1 行 2 列の数値配列として指定します。値 x と y は ROI の中心点の座標です。ROI を描画または移動すると、このプロパティの値は自動的に変化します。

Color — ROI の色

blue (既定値) | ColorSpec

ROI の色。MATLAB^® ColorSpec (Color Specification) として指定します。

例: 'green'

例: 'g'

例: [0 1 0]

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

ContextMenu オブジェクト

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

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

true (既定値) | false

コンテキスト メニューを使用して対話的に ROI を削除可能。true または false を指定します。値が true (既定の設定) の場合、コンテキスト メニューを使用して ROI を削除できます。このコンテキスト メニュー項目を無効にするには、このプロパティを false に設定します。値を 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 (既定値) | 数値スカラー

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

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

true (既定値) | false

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

FixedAspectRatio — 対話型の操作中に縦横比を一定に維持

false (既定値) | true

対話型の操作中に縦横比を一定に維持。true または false を指定します。この値が true の場合、楕円の描画やサイズ変更を行うときに ROI の縦横比は維持されます。この値が false (既定の設定) の場合、楕円の描画やサイズ変更を行うときに縦横比を変更できます。このプロパティの状態は、既定のコンテキスト メニューを使用して変更できます。

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

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

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

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

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] の範囲のスカラー値として指定します。1 に設定すると、テキストの背景は完全に不透明になります。0 に設定すると、テキストの背景は完全に透明になります。

LabelTextColor — ラベル テキストの色

'black' (既定値) | ColorSpec

ラベル テキストの色。MATLAB ColorSpec (Color Specification) として指定します。強度は [0,1] の範囲でなければなりません。

LabelVisible — ROI ラベルの可視性

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

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

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

LineWidth — ROI のエッジの幅

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

ROI のエッジの幅。ポイント単位の正の数値スカラーを指定します。既定値はスクリーン ピクセルに対する点の数の 3 倍です。

MarkerSize — マーカー サイズ

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

マーカー サイズ。ポイント単位の正の数値スカラー値として指定します。

Parent — ROI の親

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

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

RotationAngle — ROI の中心周りの角度

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

ROI の中心周りの角度。非負の数値スカラーとして指定します。角度は時計回りの方向に度単位で測定します。ROI を描画または移動すると、このプロパティの値は自動的に変化します。

RotationAngle の値は、Position の値には影響を与えません。Position プロパティは回転前の ROI の初期位置を表します。回転した ROI の位置を決定するには、Vertices プロパティを使用します。

Selected — ROI の選択状態

false (既定値) | true

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

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

'none' (既定値) | ColorSpec

選択したときの ROI の色。MATLAB ColorSpec (Color Specification) として指定します。強度は [0,1] の範囲でなければなりません。'SelectedColor' が 'none' に設定された場合、Color の値はすべての状態 (選択または未選択) の ROI の色を定義します。

例: 'green'

例: 'g'

例: [0 1 0]

SemiAxes — 楕円の半軸の長さ

[semiaxis1 semiaxis2]

楕円の半軸の長さ。[semiaxis1 semiaxis2] 形式の 1 行 2 列の配列として指定します。images.roi.Ellipse オブジェクトは x 方向に最も近い半軸の長さを semiaxis1 に割り当てます。ただし、楕円の形状と方向は、対話型の操作により変化する場合があることに注意してください。ROI の描画または形状変更を行うと、このプロパティの値は自動的に変化します。

StripeColor — ROI ストライプの色

'none' (既定値) | ColorSpec 値

ROI ストライプの色。MATLAB ColorSpec (Color Specification) 値を指定します。既定の設定では、ROI のエッジは単色で塗りつぶされます。StripeColor を指定した場合、ROI エッジはストライプ状になります。縞模様は、'Color' で指定した値とこの値の組み合わせで構成されます。

例: 'green'

例: 'g'

例: [0 1 0]

Tag — ROI に関連付けるタグ

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

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

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

任意の MATLAB データ

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

Vertices — 楕円の周囲に沿って並ぶ点の位置

n 行 2 列の配列

楕円の周囲に沿って並ぶ点の位置。n 行 2 列の配列として指定します。このプロパティは読み取り専用です。

Visible — ROI の可視性

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

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

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

オブジェクト関数

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

例

非対話形式による楕円 ROI の作成

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

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

イメージ上に楕円 ROI を作成します。Center プロパティを使用して位置を指定し、SemiAxes プロパティを使用してその形状を指定します。プログラムによって ROI を作成する場合、特定の座標軸に ROI を描画するには、座標軸を入力引数として指定しなければなりません。そうでない場合、images.roi.Ellipse クラスのインスタンスは作成されますが表示されません。この例では、現在の座標軸 (gca) を指定して、その座標軸にあるイメージに ROI を描画します。

h = images.roi.Ellipse(gca,'Center',[1000 1000],'Semiaxes',[350 150]);

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

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

I = imread('cameraman.tif');

イメージを表示します。

imshow(I);

イメージ上に楕円 ROI を描画します。この例では、ROI のサイズと位置を指定するので、draw メソッドを呼び出して対話形式による描画を有効にする必要はありません。

roi = images.roi.Ellipse(gca,'Center',[100 100],'Semiaxes',[50 80]);

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 Current Center: ' mat2str(evt.CurrentCenter)]);
            disp(['ROI moving Current SemiAxes: ' mat2str(evt.CurrentSemiAxes)]);
        case{'ROIMoved'}
            disp(['ROI moved Current Center: ' mat2str(evt.CurrentCenter)]);
            disp(['ROI moved Current SemiAxes: ' mat2str(evt.CurrentSemiAxes)]);
    end
end

詳細

イベント

特定のイベントが発生したときに ROI から通知を受け取るには、これらのイベントに対する "リスナー" を設定します。これらのイベントのいずれかが発生したときに実行するコールバック関数を指定できます。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.EllipseMovingEventData	NotifyAccess: private ListenAccess: public
ROIMoved	ROI の形状または位置が対話的に変更された。	images.roi.EllipseMovingEventData	NotifyAccess: private ListenAccess: public
ROIClicked	ROI がクリックされた。	images.roi.ROIClickedEventData	NotifyAccess: private ListenAccess: public

ヒント

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

  動作	キーボード ショートカット
  ROI の描画をキャンセルする。	Esc キーを押します。関数は Position フィールドが空の有効な ROI オブジェクトを返します。
  描画中に楕円の幅を微調整する。	楕円の描画中に、スクロール ホイールを使用して、楕円の幅を少し変更します。
  ROI を回転する。	ポインターを頂点の近くに配置します。ポインターが回転ポインターに変わります。ROI をクリックし、その中心に対して回転させます。 回転を 15 度間隔でスナップさせるには、回転中に Shift キーを押します。
  描画中に縦横比を維持する。	描画中は Shift キーを押したままにします。円 ROI を作成します。 縦横比をロックするには、ポインターを ROI に配置し、右クリックして表示されたコンテキスト メニューから [縦横比を固定] を選択します。
  ROI をサイズ変更 (形状変更) する。	頂点にポインターを配置し、クリック アンド ドラッグします。サイズ変更中に縦横比を維持するには、Shift キーを押したままにします。
  ROI を移動する。	ROI 上にポインターを配置します。ポインターが花形に変わります。クリック アンド ドラッグして ROI を移動します。
  ROI を削除する。	ROI の任意の位置にポインターを配置し、右クリックします。コンテキスト メニューから [楕円の削除] を選択します。オブジェクト関数 delete を使用して、プログラムによって ROI を削除することもできます。

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

互換性の考慮事項

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

R2020a 以降は非推奨

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

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

参考

drawellipse | AssistedFreehand | Circle | Crosshair | Cuboid | Freehand | Line | Point | Polygon | Polyline | Rectangle

トピック

• ROI 作成の概要

R2018b で導入

×

例を開く

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

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