Main Content

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

Cuboid

説明

Cuboid オブジェクトは直方体の関心領域 (ROI) です。

ROI を描画するには、カーソルを ROI に配置し、クリック アンド ドラッグして形状を移動するか形状のサイズを変更します。ROI の描画を終了するには、マウス ボタンを離します。キーボード ショートカットや右クリック コンテキスト メニューを含むこの ROI の使用方法の詳細については、ヒントを参照してください。

作成

説明

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

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

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

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

入力引数

すべて展開する

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

プロパティ

すべて展開する

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

例: 'green'

例: 'g'

例: [0 1 0]

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

コンテキスト メニューを使用して対話的に 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 にラベルはありません ('')。

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

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

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

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

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

ROI の親。Axes または UIAxes オブジェクトとして指定します。重要な制限など UIAxes で ROI を使用する方法の詳細については、App Designer を使って作成したアプリでの 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 オブジェクトを見つけるには、このタグ値を使用します。

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

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

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 の描画の開始
bringToFrontAxes のスタックの順番の最前面への ROI の移動
draw対話形式による ROI の描画の開始
inROI点が ROI 内にあるかどうかのクエリ
waitROI の操作が完了するまで MATLAB コマンド ラインをブロック

すべて折りたたむ

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)

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);

色を指定して直方体 ROI オブジェクトを作成します。オブジェクト関数 draw を呼び出して、対話形式による直方体形状の描画を有効にします。

roi = images.roi.Cuboid(gca,'Color','r');
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 の描画をキャンセルする。Esc キーを押します。関数は Position フィールドが空の有効な ROI オブジェクトを返します。
    描画中に ROI のサイズを微調整する。ROI の描画中に、スクロール ホイールを使用して、サイズを少し変更します。
    ROI をサイズ変更 (形状変更) する。

    視点から見える ROI の表面にポインターを配置し、クリック アンド ドラッグします。

    ROI を移動する。視点から見える ROI の表面にポインターを配置します。Shift キーを押しながらクリック アンド ドラッグして ROI を移動します。
    ROI を削除する。ポインターを ROI 上に配置し、右クリックして表示されたコンテキスト メニューから [直方体を削除] を選択します。オブジェクト関数 delete を使用して、プログラムによって ROI を削除することもできます。
  • App Designer を使って作成したアプリで ROI を使用する方法の詳細については、App Designer を使って作成したアプリでの ROI の使用を参照してください。

互換性の考慮事項

すべて展開する

R2020a 以降は非推奨

R2019a で導入