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

drawcrosshair

カスタマイズ可能な十字 ROI の作成

説明

roi = drawcrosshairCrosshair オブジェクトを作成し、現在の座標軸での対話形式による十字の関心領域 (ROI) の描画を有効にします。十字 ROI は、座標軸の幅全体と高さ全体に対応する、垂直な 2 つのラインで構成されます。

この ROI を描画するには、カーソルを座標軸上に移動してクリックします。キーボード ショートカットやコンテキスト メニュー オプションを含む ROI の使用方法の詳細については、ヒントを参照してください。

メモ

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

roi = drawcrosshair(ax,___) は、ax で指定される座標軸で ROI の対話型の配置を開始します。

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

すべて折りたたむ

この例では、対話形式およびプログラミングにより十字 ROI を作成する方法を示します。

十字 ROI の作成

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

figure;
imshow('pears.png')

関数 drawcrosshair を対話的に使用してイメージ上に十字 ROI を作成します。イメージの任意の位置にカーソルを移動してクリックし、ROI を描画します。ROI の中心 (水平線が垂直線と交差する点) をクリックして、イメージ上で ROI を移動します。

h = drawcrosshair();

プログラムによる十字 ROI の作成

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

figure;
imshow('pears.png')

関数 drawcrosshair を使用してイメージ上に十字 ROI を作成します。名前/値のペアの引数を使用して、ROI の初期位置を指定します。

h = drawcrosshair('Position',[100 100]);

プロパティを使用した十字 ROI の外観の変更

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

figure;
imshow('pears.png')

関数 drawcrosshair を使用してイメージ上に十字 ROI を作成します。名前/値のペアの引数を使用して、ROI の初期位置を指定します。

h = drawcrosshair('Position',[100 100]);

十字オブジェクトのプロパティを使用して、ROI のラインをストライプ状に変更します。関数 drawcrosshair は、多数のプロパティをサポートする Crosshair オブジェクトを返します。StripeColor プロパティを使用してストライプの色を指定します。

h.StripeColor = 'green';

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

img = imread('coins.png');
hAx = gca;
imObj = imshow(img,'Parent',hAx);
imObj.Parent.Visible = 'on';

十字 ROI を作成します。

h = drawcrosshair('Parent',hAx,'Position',[50 50],'LineWidth',1,'Color','y');

オブジェクト関数 addlistener を使用して、ROI が移動したときに通知を受け取ります。イベントの発生時に実行するコールバック関数を指定します。十字 ROI を移動すると、次のコードはタイトルに十字の位置を表示し、その位置のピクセル値を ROI ラベルに表示します。

addlistener(h,'MovingROI',@(src,data)displayInfo(src,data,hAx,img));

これは、十字 ROI で指定されたピクセルの値を表示するコールバック関数です。

function displayInfo(src,data,hAx,img)
pos = ceil(data.CurrentPosition);
pixval = img(pos(2),pos(1));
src.Label = mat2str(pixval);
title(mat2str(pos));
end

入力引数

すべて折りたたむ

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

名前と値のペアの引数

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

例: roi = drawcrosshair(gca,'Position',[1000 1000]);

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 は対話形式で操作できず、ドラッグ ポイントが表示されません。

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 の位置。'Position' と、[x y] 形式の 1 行 2 列の数値配列から構成されるコンマ区切りのペアとして指定します。値 xy は、十字 ROI の水平線が垂直線と交差する位置の x 座標と y 座標を指定します。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' または 'SelectedColor' で指定した値とこの値の組み合わせで構成されます。

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

ヒント

  • 次の表に、十字 ROI を使用した一般的なタスクの実行方法を示します。

    タスク説明
    描画操作をキャンセルする。ROI の描画を開始し、マウスを離す前に Esc キーを押します。関数は Position プロパティが空の有効な ROI オブジェクトを返します。
    ROI を移動する。ROI 上にポインターを配置します。ポインターが花形に変わります。クリック アンド ドラッグして ROI を移動します。
    ROI を削除する。ROI 上にポインターを配置し、右クリックしてそのコンテキスト メニューを表示します。メニューから [十字形の削除] を選択します。オブジェクト関数 delete を使用して ROI を削除することもできます。
  • 関数 drawcrosshairCrosshair ROI オブジェクトを返します。作成後、オブジェクトの次の機能を使用して、ROI の外観や動作をカスタマイズします。

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

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

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

    イベント リスナーを Crosshair オブジェクトと共に使用する例については、十字 ROI で指定されたピクセルの値の表示を参照してください。これらの機能の詳細については、Crosshair オブジェクトのドキュメンテーションを参照してください。

互換性の考慮事項

すべて展開する

R2020a 以降は非推奨

R2019b で導入