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

drawline

カスタマイズ可能なライン ROI の作成

説明

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

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

メモ

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

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

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

すべて折りたたむ

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

imshow(imread('car1.jpg'))

イメージ上に 2 つのライン ROI を描画します。選択したときの ROI の色を指定するには、名前と値のペア 'SelectedColor' を使用します。

h1 = drawline('SelectedColor','yellow');
h2 = drawline('SelectedColor','magenta');

最初のラインを黄色に変えるために、プログラムによって ROI を選択します。ROI をマウスでクリックして選択することもできます。2 番目の ROI をクリックして、マゼンタに変えます。

h1.Selected = true;

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

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

イメージ上にライン ROI を描画します。ライン ROI の位置と長さを指定するには、名前と値のペア 'Position' を使用します。名前と値のペア 'StripeColor' を指定してラインを赤いストライプ状に設定します。

h = drawline('Position',[500 500;500 1500],'StripeColor','r');

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

I = imread('cameraman.tif'); 

イメージを表示します。

imshow(I);

イメージ上にライン ROI を描画します。

roi = drawline('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

入力引数

すべて折りたたむ

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

名前と値のペアの引数

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

例: roi = drawline('LineWidth',4);

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

例: 'green'

例: 'g'

例: [0 1 0]

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

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

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

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

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

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

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

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

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

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

説明
'on'ROI が表示されていて Label プロパティが空でない場合、ラベルは表示されます (既定の設定)。
'hover'

マウスのカーソルを ROI 上に置いている場合のみ、ラベルは表示されます。

'off'ラベルは表示されません。

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

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

ROI の位置。[x1 y1; x2 y2] 形式の 2 行 2 列の配列として指定します。各行はライン ROI のそれぞれの終了点を指定します。ラインを描画または移動すると、この値は自動的に変化します。

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

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

例: 'green'

例: 'g'

例: [0 1 0]

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

例: 'green'

例: 'g'

例: [0 1 0]

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

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

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。Line オブジェクトとして返されます。

ヒント

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

    動作キーボード ショートカット
    描画したラインを 15 度間隔でスナップさせる。描画中に Shift キーを押したままにします。
    ROI の描画をキャンセルする。Esc キーを押します。関数は Position フィールドが空の有効な ROI オブジェクトを返します。
    ROI をサイズ変更する。

    ポインターをいずれかの端点に配置し、クリック アンド ドラッグして ROI をサイズ変更します。描画したラインを 15 度間隔でスナップさせるには、サイズ変更中に Shift キーを押したままにします。

    ROI を移動する。ROI 上にポインターを配置します。ポインターが花形に変わります。その後、ROI をクリック アンド ドラッグします。
    ROI を削除する。ROI の任意の位置にポインターを配置し、右クリックします。コンテキスト メニューから [ラインの削除] を選択します。オブジェクト関数 delete を使用して ROI を削除することもできます。
  • 関数 drawlineLine ROI オブジェクトを返します。作成後、オブジェクトの次の機能を使用して、ROI の外観や動作をカスタマイズします。

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

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

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

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

互換性の考慮事項

すべて展開する

R2020a 以降は非推奨

R2018b で導入