ドキュメンテーション

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

imroi

関心領域 (ROI) 基本クラス

説明

imroi クラスは抽象クラスであるため、imroi クラスのインスタンスを作成することはできません。

メソッド

imroi は、次のメソッドをサポートします。詳細なリストを参照するには、methods imroi を入力してください。

addNewPositionCallback — ROI オブジェクトに新しい位置のコールバックを追加する

id = addNewPositionCallback(h,fcn) は、ROI オブジェクト h の新しい位置のコールバック関数のリストに関数ハンドル fcn を追加します。ROI オブジェクトによって位置が変更されるときは常に、リストの各関数が次の構文で呼び出されます。

fcn(pos)

ここで、pos は、オブジェクトの getPosition メソッドによって返される形式です。

戻り値 id は、removeNewPositionCallback と一緒にのみ使用されます。

createMask — イメージ内にマスクを作成する

BW = createMask(h) は、マスク、すなわち、バイナリ イメージを返しますが、このサイズは、ROI オブジェクト h の内側の場合は 1、それ以外の場合は 0 の入力イメージと同じです。入力イメージは、ROI と同じ座標軸内に含まれなければなりません。

BW = createMask(h,h_im) は、ROI オブジェクト h の内側では 1、外側では 0 のイメージ h_im と同じサイズのマスクを返します。この構文は、ROI を含んでいる座標軸が複数のイメージを保持する場合に要求されます。

delete — ROI オブジェクトを削除する

delete(h) は、ROI オブジェクト h を削除します。

getColor — ROI オブジェクトの描画に使用する色を取得する

color = getColor(h) は、ROI オブジェクト h の描画に使用する色を取得します。3 要素ベクトル color が RGB 3 成分を指定します。

getPosition — ROI オブジェクトの現在の位置を返す

pos = getPosition(h) は ROI オブジェクト h の現在の位置を返します。

getPositionConstraintFcn — 現在の位置の制約関数の関数ハンドルを返す

fcn = getPositionConstraintFcn(h) は、関数ハンドル fcn を ROI オブジェクト h の現在の位置の制約関数に返します。

removeNewPositionCallback — ROI オブジェクトから新しい位置のコールバックを削除する

removeNewPositionCallback(h,id) は ROI オブジェクト h の新しい位置のコールバックのリストから対応する関数を削除します。id は、addNewPositionCallback メソッドによって返される識別子です。

resume — MATLAB コマンド ラインの実行を再開する

resume(h) は、MATLAB コマンド ラインの実行を再開します。resume は、wait を呼び出した後に呼び出されると、受け入れられた位置が wait によって返されます。resume メソッドは、コールバック関数から wait を終了する必要がある場合に便利です。

setColor — ROI オブジェクトの描画に使用する色を設定する

setColor(h,new_color) は、ROI オブジェクト h の描画に使用する色を設定します。new_color は、RGB 3 成分を指定する 3 要素ベクトルまたは事前定義された色の完全名または省略名 ('white''w' など) です。定義済み色の一覧は、「ColorSpec」を参照してください。

setConstrainedPosition — ROI オブジェクトを新しい位置に設定する

setConstrainedPosition(h,candidate_position) は、ROI オブジェクト h の位置を新しい位置に設定します。位置の候補は、位置制約関数に従います。candidate_position は、setPosition メソッドによって出力される形式です。

setPositionConstraintFcn — ROI オブジェクトの位置制約関数を設定する

setPositionConstraintFcn(h,fcn) は、ROI オブジェクト h の位置制約関数を指定した関数ハンドル fcn に設定します。オブジェクトがマウスのドラッグによって移動されると、次の構文を使用して制約関数が呼び出されます。

constrained_position = fcn(new_position)

ここで、new_position は、getPosition メソッドによって出力される形式です。この関数を作成するには、makeConstrainToRectFcn を使用します。

wait — ROI の作成が完了するまで MATLAB コマンド ラインをブロックする

accepted_pos = wait(h) は、ROI オブジェクト h の配置が終了するまで、MATLAB コマンド ラインの実行をブロックします。配置が完了したことを示すには、ROI オブジェクトをダブルクリックします。返される位置 accepted_pos の形式は、オブジェクトの getPosition メソッドによって返される形式です。

R2008a で導入

この情報は役に立ちましたか?