ドキュメンテーション

このページは前リリースの情報です。該当の英語のページはこのリリースで削除されています。

images.roi.Cuboid クラス

パッケージ: images.roi

説明

images.roi.Cuboid クラスは直方体の関心領域 (ROI) オブジェクトを作成します。オブジェクトの draw メソッドを呼び出し、マウスを使用して ROI の対話型の描画を開始します。マウスを使用して、ROI のサイズや位置を調整することもできます。ROI には、その外観や動作などを制御するコンテキスト メニューもあります。

ROI を対話的に作成するには、事前に描画した ROI 上にポインターを配置し、ポインターを Figure 内の任意の位置に移動してクリックします。直方体を削除するには、ポインターを ROI 上に配置し、右クリックして表示されたコンテキスト メニューから [直方体を削除] を選択します。キーボード ショートカットを含む対話型動作の詳細については、ヒントを参照してください。

images.roi.Cuboid クラスは handle クラスです。

作成

説明

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

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

h = images.roi.Cuboid(___,Name,Value) は、1 つ以上の ROI プロパティに値を指定することによって ROI の外観や動作を変更します。プロパティは、名前と値のペアを使用して設定できます。座標軸は指定してもしなくてもかまいません。

入力引数

すべて展開する

ROI の親。Axes オブジェクトとして指定します。

プロパティ

すべて展開する

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

例: 'green'

例: 'g'

例: [0 1 0]

コンテキスト メニューを使用して対話的に ROI を削除可能。true または false を指定します。値が true (既定の設定) の場合、コンテキスト メニューを使用して ROI を削除できます。このコンテキスト メニュー項目を無効にするには、このプロパティを false に設定します。値を false に設定した場合でも、ROI のハンドルを入力として指定して関数 delete を呼び出すことによって、ROI を削除できます。

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

説明
'auto'

描画領域は、現在の座標軸の範囲と ROI を囲む境界ボックスのスーパーセットです (既定の設定)。

'unlimited'描画領域には境界がなく、座標軸の範囲を超えて ROI を描画したりドラッグしたりできます。
[x,y,z,w,h,d]描画領域は、(x,y,z) を基準として幅 w、高さ h、奥行 d を持つ領域に制限されます。

ROI エッジの透明度。[0 1] の範囲の非負の数値スカラー値として指定します。1 に設定すると、ROI エッジは完全に不透明になります。0 に設定すると、ROI エッジは完全に透明になります。

例: drawcuboid('EdgeAlpha',0.2)

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

マウス ポインターの直下にある ROI 面の透明度。[0 1] の範囲のスカラー値として、または、面の透明度に変更がないことを示す 'none' として指定します。1 に設定すると、マウス ポインターの下にある面は完全に不透明になります。0 に設定すると、面は完全に透明になります。

例: drawcuboid('FaceAlphaOnHover',1)

マウス ポインターの直下にある ROI 面の色。MATLAB ColorSpec (Color Specification) または 'none' として指定します。既定では、カーソルを置いても面の色は変化しません ROI の面上にカーソルを置いていない場合、ROI の Color プロパティの値によって面の色が決まります。強度は [0,1] の範囲でなければなりません。

例: drawcuboid('FaceAlphaOnHover',1)

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

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

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

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

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

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

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

ROI のエッジの幅。ポイント単位の正の数値スカラーを指定します。

ROI の親。Axes オブジェクトとして指定します。UIAxes を ROI の親にすることはできません。

直方体の位置。[xmin, ymin, zmin, width, height, depth] 形式の 1 行 6 列の配列として指定します。直方体を描画または移動すると、このプロパティは自動的に更新されます。

直方体の回転可能性。次のいずれかの値を指定します。

説明
'all'ROI は完全に回転できます。
'x' ROI は x 軸を中心としてのみ回転できます。
'y'ROI は y 軸を中心としてのみ回転できます。
'z'ROI は z 軸を中心としてのみ回転できます。
'none'ROI は回転できません。

ROI の回転の角度。度単位で測定した回転角の 1 行 3 列の数値配列として指定します。回転角の配列は [x_angle y_angle z_angle] の形式であり、それぞれ x 軸、y 軸、z 軸を中心として測定されます。回転は、ROI の重心を中心として、z、y、x の順に適用されます。

RotationAngle の値は、Position プロパティの値には影響を与えません。Position は回転前の直方体を表します。直方体を回転するときは、Vertices プロパティを使用して回転後の直方体の位置を決定します。

対話型の配置中のスクロール ホイールによる直方体のサイズの調整可能性。次のいずれかの値を指定します。

説明
'allresize'スクロール ホイールは、ROI のすべての次元に影響を与えます。
'xresize' スクロール ホイールは x 次元にのみ影響を与えます。
'yresize' スクロール ホイールは y 次元にのみ影響を与えます。
'zresize' スクロール ホイールは z 次元にのみ影響を与えます。
'none'スクロール ホイールには効果がありません。

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

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

例: 'green'

例: 'g'

例: [0 1 0]

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

例: 'green'

例: 'g'

例: [0 1 0]

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

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

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

直方体 ROI のコーナーの位置。8 行 3 列の配列として返されます。

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

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

メソッド

すべて展開する

イベント

イベント名トリガーイベント データイベント属性
DeletingROIROI が対話的に削除されようとしている。event.EventData

NotifyAccess: private

ListenAccess: public

DrawingStartedROI が対話的に描画されようとしている。event.EventData

NotifyAccess: private

ListenAccess: public

DrawingFinishedROI が対話的に描画された。event.EventData

NotifyAccess: private

ListenAccess: public

MovingROIROI の形状または位置が対話的に変更中である。images.roi.CuboidMovingEventData

NotifyAccess: private

ListenAccess: public

ROIMovedROI の形状または位置が対話的に変更された。images.roi.CuboidMovingEventData

NotifyAccess: private

ListenAccess: public

ROIClickedROI がクリックされた。images.roi.ROIClickedEventData

NotifyAccess: private

ListenAccess: public

すべて折りたたむ

3 次元散布データのベクトルを定義します。

[x,y,z] = sphere(16);
X = [x(:)*.5 x(:)*.75 x(:)];
Y = [y(:)*.5 y(:)*.75 y(:)];
Z = [z(:)*.5 z(:)*.75 z(:)];

各マーカーのサイズと色を指定します。

S = repmat([1 .75 .5]*10,numel(x),1);
C = repmat([1 2 3],numel(x),1);

3 次元散布図を作成し、ビューを使用して Figure 内の座標軸の角度を変更します。

figure
hScatter = scatter3(X(:),Y(:),Z(:),S(:),C(:),'filled'); 
view(-60,60);

座標軸への直方体の配置を開始します。直方体は散布図の最も近い点にスナップされます。対話型の配置中に、スクロール ホイールを使用して直方体のサイズを調整します。

ax = gca;
h = images.roi.Cuboid(ax);
draw(h)

ヒント

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

    動作キーボード ショートカット
    描画中に ROI のサイズを微調整する。スクロール ホイールを使用して、描画中に ROI のサイズを少し変更します。
    ROI の描画を中断する。Esc キーを押します。関数は Position フィールドが空の有効な ROI オブジェクトを返します。
    ROI をサイズ変更 (形状変更) する。

    ポインターを直方体のいずれかの表示面に配置して、その面をクリック アンド ドラッグします。面を選択するために直方体を回転させなければならない場合があります。

    Shift キーを押したままマウスをドラッグすると、ROI は移動しますが、どの次元も変化しません。

    ROI を移動する。

    ポインターを ROI のいずれかの表示面に配置して、Shift キーを押したままクリック アンド ドラッグします。

    ROI の表示面にポインターを配置し、右クリックして [次元をロック] を選択します。クリック アンド ドラッグして ROI を移動します。

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

R2019a で導入