jp.nyatla.nyartoolkit.markersystem

クラス NyARMarkerSystem

java.lang.Object

jp.nyatla.nyartoolkit.markersystem.NyARSingleCameraSystem

jp.nyatla.nyartoolkit.markersystem.NyARMarkerSystem

public class NyARMarkerSystem
extends NyARSingleCameraSystem

このクラスは、マーカベースARの制御クラスです。 複数のARマーカとNyIDの検出情報の管理機能、撮影画像の取得機能を提供します。 このクラスは、ARToolKit固有の座標系を出力します。他の座標系を出力するときには、継承クラスで変換してください。 レンダリングシステム毎にクラスを派生させて使います。Javaの場合には、OpenGL用のNyARGlMarkerSystemクラスがあります。

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static int	LOST_DELAY_DEFAULT マーカ消失時の、消失までのﾃﾞｨﾚｲ(フレーム数)の初期値です。
static int	THLESHOLD_AUTO 定数値。

クラスから継承されたフィールド jp.nyatla.nyartoolkit.markersystem.NyARSingleCameraSystem

FRUSTUM_DEFAULT_FAR_CLIP, FRUSTUM_DEFAULT_NEAR_CLIP

コンストラクタの概要

コンストラクタ

コンストラクタと説明
NyARMarkerSystem(INyARMarkerSystemConfig i_config) コンストラクタです。

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
int	addARMarker(java.io.InputStream i_stream, int i_patt_resolution, int i_patt_edge_percentage, double i_marker_size) この関数は、ARToolKitスタイルのマーカーをストリームから読みだして、登録します。
int	addARMarker(INyARRgbRaster i_raster, int i_patt_resolution, int i_patt_edge_percentage, double i_marker_size) この関数は、画像からARマーカパターンを生成して、登録します。
int	addARMarker(NyARCode i_code, int i_patt_edge_percentage, double i_marker_size) この関数は、ARToolKitスタイルのマーカーを登録します。
int	addARMarker(java.lang.String i_file_name, int i_patt_resolution, int i_patt_edge_percentage, double i_marker_size) この関数は、ARToolKitスタイルのマーカーをファイルから読みだして、登録します。
int	addNyIdMarker(long i_id, double i_marker_size) この関数は、1個のIdマーカをシステムに登録して、検出可能にします。
int	addNyIdMarker(long i_id_s, long i_id_e, double i_marker_size) この関数は、1個の範囲を持つidマーカをシステムに登録して、検出可能にします。
int	addPsARPlayCard(int i_id, double i_marker_size) この関数は、1個のARプレイマーカをシステムに登録して、検出可能にします。
int	addPsARPlayCard(int i_id_s, int i_id_e, double i_marker_size) この関数は、1個の範囲を持つARプレイマーカをシステムに登録して、検出可能にします。
double	getConfidence(int i_id) この関数は、ARマーカの最近の一致度を返します。
int	getCurrentThreshold() この関数は、現在の２値化敷居値を返します。
long	getLife(int i_id) この関数は、マーカのライフ値を返します。
long	getLostCount(int i_id) この関数は、マーカの消失カウンタの値を返します。
NyARDoubleMatrix44	getMarkerMatrix(int i_id) この関数は、マーカの姿勢変換行列を返します。
INyARRgbRaster	getMarkerPlaneImage(int i_id, NyARSensor i_sensor, double i_x1, double i_y1, double i_x2, double i_y2, double i_x3, double i_y3, double i_x4, double i_y4, INyARRgbRaster i_raster) この関数は、マーカ平面上の任意の４点で囲まれる領域から、画像を射影変換して返します。
INyARRgbRaster	getMarkerPlaneImage(int i_id, NyARSensor i_sensor, double i_l, double i_t, double i_w, double i_h, INyARRgbRaster i_raster) この関数は、マーカ平面上の任意の矩形で囲まれる領域から、画像を射影変換して返します。
NyARDoublePoint3d	getMarkerPlanePos(int i_id, int i_x, int i_y, NyARDoublePoint3d i_out) この関数は、スクリーン座標点をマーカ平面の点に変換します。
NyARIntPoint2d[]	getMarkerVertex2D(int i_id) この関数は、マーカの4頂点の、スクリーン上の二次元座標を返します。
long	getNyId(int i_id) この関数は、NyIdマーカのID値を返します。
NyARDoublePoint2d	getScreenPos(int i_id, double i_x, double i_y, double i_z, NyARDoublePoint2d i_out) この関数は、マーカ座標系の点をスクリーン座標へ変換します。
boolean	isExistMarker(int i_id) この関数は、 マーカIDに対応するマーカが検出されているかを返します。
void	setBinThreshold(int i_th) この関数は、2値化敷居値を設定します。
void	setConfidenceThreshold(double i_val) この関数は、ARマーカ検出の、敷居値を設定します。
void	setLostDelay(int i_delay) この関数は、消失時のディレイ値を指定します。
void	update(NyARSensor i_sensor) この関数は、入力したセンサ入力値から、インスタンスの状態を更新します。

クラスから継承されたメソッド jp.nyatla.nyartoolkit.markersystem.NyARSingleCameraSystem

addObserver, getARParam, getFrustum, setProjectionMatrixClipping

クラスから継承されたメソッド java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

THLESHOLD_AUTO

public static final int THLESHOLD_AUTO

定数値。自動敷居値を示す値です。

関連項目:

定数フィールド値

LOST_DELAY_DEFAULT

public static final int LOST_DELAY_DEFAULT

マーカ消失時の、消失までのﾃﾞｨﾚｲ(フレーム数)の初期値です。

関連項目:

定数フィールド値

コンストラクタの詳細

NyARMarkerSystem

public NyARMarkerSystem(INyARMarkerSystemConfig i_config)
                 throws NyARException

コンストラクタです。INyARMarkerSystemConfigを元に、インスタンスを生成します。

パラメータ:

i_config - 初期化済のMarkerSystemを指定します。

例外:

NyARException

メソッドの詳細

addNyIdMarker

public int addNyIdMarker(long i_id,
                double i_marker_size)
                  throws NyARException

この関数は、1個のIdマーカをシステムに登録して、検出可能にします。 関数はマーカに対応したID値（ハンドル値）を返します。

パラメータ:

i_id - 登録するNyIdマーカのid値

i_marker_size - マーカの四方サイズ[mm]

戻り値:

マーカID（ハンドル）値。この値はIDの値ではなく、マーカのハンドル値です。

例外:

NyARException

addNyIdMarker

public int addNyIdMarker(long i_id_s,
                long i_id_e,
                double i_marker_size)
                  throws NyARException

この関数は、1個の範囲を持つidマーカをシステムに登録して、検出可能にします。 インスタンスは、i_id_s<=n<=i_id_eの範囲にあるマーカを検出します。 例えば、1番から5番までのマーカを検出する場合に使います。 関数はマーカに対応したID値（ハンドル値）を返します。

パラメータ:

i_id_s - Id範囲の開始値

i_id_e - Id範囲の終了値

i_marker_size - マーカの四方サイズ[mm]

戻り値:

マーカID（ハンドル）値。この値はNyIDの値ではなく、マーカのハンドル値です。

例外:

NyARException

addPsARPlayCard

public int addPsARPlayCard(int i_id_s,
                  int i_id_e,
                  double i_marker_size)
                    throws NyARException

この関数は、1個の範囲を持つARプレイマーカをシステムに登録して、検出可能にします。 インスタンスは、i_id_s<=n<=i_id_eの範囲にあるマーカを検出します。 例えば、1番から5番までのマーカを検出する場合に使います。 関数はマーカに対応したID値（ハンドル値）を返します。

パラメータ:

i_id_s - Id範囲の開始値 (1<=n<=6)

i_id_e - Id範囲の終了値 (1<=n<=6)

i_marker_size - マーカの四方サイズ[mm]

戻り値:

マーカID（ハンドル）値。この値はIDの値ではなく、マーカのハンドル値です。

例外:

NyARException

addPsARPlayCard

public int addPsARPlayCard(int i_id,
                  double i_marker_size)
                    throws NyARException

この関数は、1個のARプレイマーカをシステムに登録して、検出可能にします。 関数はマーカに対応したID値（ハンドル値）を返します。

パラメータ:

i_id - PSARプレイマーカのID。1-6までの数値です。

i_marker_size - マーカの四方サイズ[mm]

戻り値:

マーカID（ハンドル）値。この値はIDの値ではなく、マーカのハンドル値です。

例外:

NyARException

addARMarker

public int addARMarker(NyARCode i_code,
              int i_patt_edge_percentage,
              double i_marker_size)
                throws NyARException

この関数は、ARToolKitスタイルのマーカーを登録します。

パラメータ:

i_code - 登録するマーカパターンオブジェクト

i_patt_edge_percentage - エッジ割合。ARToolkitと同じ場合は25を指定します。

i_marker_size - マーカの平方サイズ[mm]

戻り値:

マーカID（ハンドル）値。

例外:

NyARException

addARMarker

public int addARMarker(java.io.InputStream i_stream,
              int i_patt_resolution,
              int i_patt_edge_percentage,
              double i_marker_size)
                throws NyARException

この関数は、ARToolKitスタイルのマーカーをストリームから読みだして、登録します。

パラメータ:

i_stream - マーカデータを読み出すストリーム

i_patt_edge_percentage - エッジ割合。ARToolkitと同じ場合は25を指定します。

i_marker_size - マーカの平方サイズ[mm]

戻り値:

マーカID（ハンドル）値。

例外:

NyARException

addARMarker

public int addARMarker(java.lang.String i_file_name,
              int i_patt_resolution,
              int i_patt_edge_percentage,
              double i_marker_size)
                throws NyARException

この関数は、ARToolKitスタイルのマーカーをファイルから読みだして、登録します。

パラメータ:

i_stream - マーカデータを読み出すストリーム

i_patt_edge_percentage - エッジ割合。ARToolkitと同じ場合は25を指定します。

i_marker_size - マーカの平方サイズ[mm]

戻り値:

マーカID（ハンドル）値。

例外:

NyARException

addARMarker

public int addARMarker(INyARRgbRaster i_raster,
              int i_patt_resolution,
              int i_patt_edge_percentage,
              double i_marker_size)
                throws NyARException

この関数は、画像からARマーカパターンを生成して、登録します。 ビットマップ等の画像から生成したパターンは、撮影画像から生成したパターンファイルと比較して、撮影画像の色調変化に弱くなります。 注意してください。

パラメータ:

i_raster - マーカ画像を格納したラスタオブジェクト

i_patt_resolution - マーカの解像度

i_patt_edge_percentage - マーカのエッジ領域のサイズ。マーカパターンは、i_rasterからエッジ領域を除いたパターンから生成します。 ARToolKitスタイルの画像を用いる場合は、25を指定します。

i_marker_size - マーカの平方サイズ[mm]

戻り値:

マーカID（ハンドル）値。

例外:

NyARException

isExistMarker

public boolean isExistMarker(int i_id)
                      throws NyARException

この関数は、 マーカIDに対応するマーカが検出されているかを返します。

パラメータ:

i_id - マーカID（ハンドル）値。

戻り値:

マーカを検出していればtrueを返します。

例外:

NyARException

getConfidence

public double getConfidence(int i_id)
                     throws NyARException

この関数は、ARマーカの最近の一致度を返します。 isExistMarker(int)がtrueの時にだけ使用できます。 値は初期の一致度であり、トラッキング中は変動しません。

パラメータ:

i_id - マーカID（ハンドル）値。

戻り値:

0<n<1の一致度。

例外:

NyARException

getNyId

public long getNyId(int i_id)
             throws NyARException

この関数は、NyIdマーカのID値を返します。 範囲指定で登録したNyIdマーカから、実際のIDを得るために使います。

パラメータ:

i_id - マーカID（ハンドル）値。

戻り値:

現在のNyIdの値

例外:

NyARException

getCurrentThreshold

public int getCurrentThreshold()

この関数は、現在の２値化敷居値を返します。 自動敷居値を選択している場合は、直近に検出した敷居値を返します。

戻り値:

敷居値(0-255)

getLife

public long getLife(int i_id)
             throws NyARException

この関数は、マーカのライフ値を返します。 ライフ値は、フレーム毎に加算される寿命値です。

パラメータ:

i_id - マーカID（ハンドル）値。

戻り値:

ライフ値

例外:

NyARException

getLostCount

public long getLostCount(int i_id)
                  throws NyARException

この関数は、マーカの消失カウンタの値を返します。 消失カウンタの値は、マーカを一時的にロストした時に加算される値です。再度検出した時に0にリセットされます。

パラメータ:

i_id - マーカID（ハンドル）値。

戻り値:

消失カウンタの値

例外:

NyARException

getMarkerPlanePos

public NyARDoublePoint3d getMarkerPlanePos(int i_id,
                                  int i_x,
                                  int i_y,
                                  NyARDoublePoint3d i_out)
                                    throws NyARException

この関数は、スクリーン座標点をマーカ平面の点に変換します。 isExistMarker(int)がtrueの時にだけ使用できます。

パラメータ:

i_id - マーカID（ハンドル）値。

i_x - 変換元のスクリーン座標

i_y - 変換元のスクリーン座標

i_out - 結果を格納するオブジェクト

戻り値:

結果を格納したi_outに設定したオブジェクト

例外:

NyARException

getScreenPos

public NyARDoublePoint2d getScreenPos(int i_id,
                             double i_x,
                             double i_y,
                             double i_z,
                             NyARDoublePoint2d i_out)
                               throws NyARException

この関数は、マーカ座標系の点をスクリーン座標へ変換します。 isExistMarker(int)がtrueの時にだけ使用できます。

パラメータ:

i_id - マーカID（ハンドル）値。

i_x - マーカ座標系のX座標

i_y - マーカ座標系のY座標

i_z - マーカ座標系のZ座標

i_out - 結果を格納するオブジェクト

戻り値:

結果を格納したi_outに設定したオブジェクト

例外:

NyARException

getMarkerPlaneImage

public INyARRgbRaster getMarkerPlaneImage(int i_id,
                                 NyARSensor i_sensor,
                                 double i_x1,
                                 double i_y1,
                                 double i_x2,
                                 double i_y2,
                                 double i_x3,
                                 double i_y3,
                                 double i_x4,
                                 double i_y4,
                                 INyARRgbRaster i_raster)
                                   throws NyARException

この関数は、マーカ平面上の任意の４点で囲まれる領域から、画像を射影変換して返します。 isExistMarker(int)がtrueの時にだけ使用できます。

パラメータ:

i_id - マーカID（ハンドル）値。

i_sensor - 画像を取得するセンサオブジェクト。通常はupdate(NyARSensor)関数に入力したものと同じものを指定します。

i_x1 - 頂点1[mm]

i_y1 - 頂点1[mm]

i_x2 - 頂点2[mm]

i_y2 - 頂点2[mm]

i_x3 - 頂点3[mm]

i_y3 - 頂点3[mm]

i_x4 - 頂点4[mm]

i_y4 - 頂点4[mm]

i_raster - 取得した画像を格納するオブジェクト

戻り値:

結果を格納したi_rasterオブジェクト

例外:

NyARException

getMarkerPlaneImage

public INyARRgbRaster getMarkerPlaneImage(int i_id,
                                 NyARSensor i_sensor,
                                 double i_l,
                                 double i_t,
                                 double i_w,
                                 double i_h,
                                 INyARRgbRaster i_raster)
                                   throws NyARException

この関数は、マーカ平面上の任意の矩形で囲まれる領域から、画像を射影変換して返します。 isExistMarker(int)がtrueの時にだけ使用できます。

パラメータ:

i_id - マーカID（ハンドル）値。

i_sensor - 画像を取得するセンサオブジェクト。通常はupdate(NyARSensor)関数に入力したものと同じものを指定します。

i_l - 矩形の左上点です。

i_t - 矩形の左上点です。

i_w - 矩形の幅です。

i_h - 矩形の幅です。

i_raster - 出力先のオブジェクト

戻り値:

結果を格納したi_rasterオブジェクト

例外:

NyARException

getMarkerMatrix

public NyARDoubleMatrix44 getMarkerMatrix(int i_id)
                                   throws NyARException

この関数は、マーカの姿勢変換行列を返します。 マーカID（ハンドル）値。

戻り値:

[readonly] 姿勢行列を格納したオブジェクト。座標系は、ARToolKit座標系です。

例外:

NyARException

getMarkerVertex2D

public NyARIntPoint2d[] getMarkerVertex2D(int i_id)
                                   throws NyARException

この関数は、マーカの4頂点の、スクリーン上の二次元座標を返します。

パラメータ:

i_id - マーカID（ハンドル）値。

戻り値:

[readonly]

例外:

NyARException

setBinThreshold

public void setBinThreshold(int i_th)

この関数は、2値化敷居値を設定します。

パラメータ:

i_th - 2値化敷居値。THLESHOLD_AUTOを指定すると、自動調整になります。

setConfidenceThreshold

public void setConfidenceThreshold(double i_val)

この関数は、ARマーカ検出の、敷居値を設定します。 ここで設定した値以上の一致度のマーカを検出します。

パラメータ:

i_val - 敷居値。0.0<n<1.0の値を指定すること。

setLostDelay

public void setLostDelay(int i_delay)

この関数は、消失時のディレイ値を指定します。 デフォルト値は、LOST_DELAY_DEFAULTです。 MarkerSystemは、ここで指定した回数を超えて連続でマーカを検出できないと、マーカが消失したと判定します。

パラメータ:

i_delay - 回数を指定します。

update

public void update(NyARSensor i_sensor)
            throws NyARException

この関数は、入力したセンサ入力値から、インスタンスの状態を更新します。 関数は、センサオブジェクトから画像を取得して、マーカ検出、一致判定、トラッキング処理を実行します。

パラメータ:

i_sensor - MarkerSystemに入力する画像を含むセンサオブジェクト。

例外:

NyARException