jp.nyatla.nyar4psg

クラス MultiNft

java.lang.Object

jp.nyatla.nyar4psg.utils.NyARPsgBaseClass

jp.nyatla.nyar4psg.MultiNft

public class MultiNft
extends NyARPsgBaseClass

このクラスは、同時に複数のNFTマーカを取り扱える検出・トラッキングクラスです。 PImage画像の入力から、NFTマーカの位置姿勢を検出することができます。

フィールドの概要

クラスから継承されたフィールド jp.nyatla.nyar4psg.utils.NyARPsgBaseClass

cameraview, FRUSTUM_DEFAULT_FAR_CLIP, FRUSTUM_DEFAULT_NEAR_CLIP, VERSION

コンストラクタの概要

コンストラクタ

コンストラクタと説明
MultiNft(processing.core.PApplet parent, int i_width, int i_height, double[] i_intrinsic_matrix, double[] i_distortion_coeffs, int i_screen_width, int i_screen_height) コンストラクタです。
MultiNft(processing.core.PApplet parent, int i_width, int i_height, java.lang.String i_cparam_file) コンストラクタです。
MultiNft(processing.core.PApplet parent, int i_width, int i_height, java.lang.String i_cparam_file, NyAR4PsgConfig i_config) コンストラクタです。

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
int	addNftTarget(java.lang.String i_file_name_prefix) この関数は、NFTファイルセットからNFTターゲットを生成して登録します。
int	addNftTarget(java.lang.String i_file_name_prefix, float i_target_width) この関数は、NFTファイルセットからNFTターゲットを生成して登録します。
int	addNftTarget(java.lang.String i_file_name_prefix, int i_page_no, float i_target_width) この関数は、NFTファイルセットからNFTターゲットを生成して登録します。
void	beginTransform(int i_id) この関数は、ProcessingのProjectionMatrixとModelview行列に指定idのマーカ平面にセットします。
void	detect(processing.core.PImage i_image) この関数は、画像からマーカーの検出処理を実行します。
void	detect(processing.core.PImage i_image, boolean i_with_loadpixels) この関数は、画像からマーカーの検出処理を実行します。
void	detect(PImageSensor i_source_image) PImageSensorの内容でインスタンスを更新します。
void	dispose() Processing callback function インスタンスが起動したマルチスレッドを終了時に停止します。
void	endTransform() この関数は、beginTransform(int)でセットしたProjectionとModelViewを元に戻します。
processing.core.PMatrix3D	getMatrix(int i_id) この関数は、マーカの姿勢行列を返します。
processing.core.PMatrix3D	getTargetMatrix(int i_id) 非推奨です。
boolean	isExist(int i_id) 指定idのターゲットが有効かを返します。
boolean	isExistTarget(int i_id) 非推奨です。
processing.core.PVector	object2ScreenCoordSystem(int i_id, double i_x, double i_y, double i_z) この関数は、idで示されるマーカ座標系の点をスクリーン座標へ変換します。
processing.core.PImage	pickupImage(int i_id, int i_x1, int i_y1, int i_x2, int i_y2, int i_x3, int i_y3, int i_x4, int i_y4, int i_out_w_pix, int i_out_h_pix) この関数は、idで指定したマーカの画像のXY平面上の4頂点でかこまれた領域から、画像を取得します。
processing.core.PImage	pickupRectImage(int i_id, int i_l, int i_t, int i_w, int i_h, int i_out_w_pix, int i_out_h_pix) この関数は、idで指定したマーカのXY平面上の矩形領域から、画像を取得します。
processing.core.PImage	pickupRectTargetImage(int i_id, int i_l, int i_t, int i_w, int i_h, int i_out_w_pix, int i_out_h_pix) 非推奨です。
processing.core.PImage	pickupTargetImage(int i_id, int i_x1, int i_y1, int i_x2, int i_y2, int i_x3, int i_y3, int i_x4, int i_y4, int i_out_w_pix, int i_out_h_pix) 非推奨です。
processing.core.PVector	screen2ObjectCoordSystem(int i_id, int i_x, int i_y) この関数は、スクリーン座標をidで指定したマーカ平面座標へ変換して返します。
processing.core.PVector	screen2TargetCoordSystem(int i_id, int i_x, int i_y) 非推奨です。
processing.core.PVector	target2ScreenCoordSystem(int i_id, double i_x, double i_y, double i_z) 非推奨です。

クラスから継承されたメソッド jp.nyatla.nyar4psg.utils.NyARPsgBaseClass

drawBackground, getProjectionMatrix, setARClipping, setARPerspective, setBackgroundOrtho, setPerspective

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

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

コンストラクタの詳細

MultiNft

public MultiNft(processing.core.PApplet parent,
        int i_width,
        int i_height,
        java.lang.String i_cparam_file,
        NyAR4PsgConfig i_config)

コンストラクタです。

パラメータ:

parent - 親となるAppletオブジェクトを指定します。

i_cparam_file - ARToolKitフォーマットのカメラパラメータファイルの名前を指定します。

i_width - 入力画像の横解像度を指定します。通常、キャプチャ画像のサイズを指定します。

i_height - 入力画像の横解像度を指定します。通常、キャプチャ画像のサイズを指定します。

i_config - コンフィギュレーションオブジェクトを指定します。

例外:

jp.nyatla.nyartoolkit.core.NyARRuntimeException

MultiNft

public MultiNft(processing.core.PApplet parent,
        int i_width,
        int i_height,
        java.lang.String i_cparam_file)

コンストラクタです。 MultiNft(PApplet, int, int, String, NyAR4PsgConfig)のコンフィギュレーションに、NyAR4PsgConfig#CONFIG_DEFAULTを指定した物と同じです。

パラメータ:

parent - MultiNft(PApplet, int, int, String, NyAR4PsgConfig)を参照。

i_width - 入力画像の横解像度を指定します。通常、キャプチャ画像のサイズを指定します。

i_height - 入力画像の横解像度を指定します。通常、キャプチャ画像のサイズを指定します。

i_cparam_file - MultiNft(PApplet, int, int, String, NyAR4PsgConfig)を参照。

例外:

jp.nyatla.nyartoolkit.core.NyARRuntimeException

MultiNft

public MultiNft(processing.core.PApplet parent,
        int i_width,
        int i_height,
        double[] i_intrinsic_matrix,
        double[] i_distortion_coeffs,
        int i_screen_width,
        int i_screen_height)

コンストラクタです。 OpenCVのカメラパラメータ値を使ってインスタンスを生成します。

パラメータ:

i_width - カメラパラメータのサイズ値

i_height - カメラパラメータのサイズ値

i_intrinsic_matrix - 3x3 matrix このパラメータは、OpenCVのcvCalibrateCamera2関数が出力するintrinsic_matrixの値と合致します。

i_distortion_coeffs - 4x1 matrix このパラメータは、OpenCVのcvCalibrateCamera2関数が出力するdistortion_coeffsの値と合致します。

i_screen_width - 入力画像の横解像度を指定します。通常、キャプチャ画像のサイズを指定します。

i_screen_height - 入力画像の横解像度を指定します。通常、キャプチャ画像のサイズを指定します。

メソッドの詳細

beginTransform

public void beginTransform(int i_id)

この関数は、ProcessingのProjectionMatrixとModelview行列に指定idのマーカ平面にセットします。 必ずendTransform()とペアで使ってください。 関数を実行すると、現在のModelView行列とProjection行列を退避した後に、新しい行列がセットされます。 これらを復帰するには、endTransform()を使います。 復帰するまでの間は、再度beginTransform(int)を使うことはできません。

この関数は、次のコードと等価です。

:
//prev_matは現在の行列退避用。endTransformで使用する。
PMatrix3D prev_mat=new PMatrix3D(((PGraphicsOpenGL)g).projection);
setARPerspective();
pushMatrix();
setMatrix(ar.getMarkerMatrix(i_id));
:

パラメータ:

i_id - マーカidを指定します。

endTransform

public void endTransform()

この関数は、beginTransform(int)でセットしたProjectionとModelViewを元に戻します。 必ずbeginTransform(int)とペアで使ってください。

この関数は、次のコードと等価です。

:
setPerspective(prev_mat);//prev_matはsetARPerspectiveで退避した行列。
pushMatrix();
setMatrix(ar.getMarkerMatrix());
:

detect

public void detect(processing.core.PImage i_image)

この関数は、画像からマーカーの検出処理を実行します。 関数は、i_imageに対して1度だけPImage.loadPixels()を実行します。 PImage.loadPixels()のタイミングをコントロールしたい場合は、#detectWithoutLoadPixelsを使用してください。

パラメータ:

i_image - 検出処理を行う画像を指定します。

detect

public void detect(processing.core.PImage i_image,
          boolean i_with_loadpixels)

この関数は、画像からマーカーの検出処理を実行します。 引数と戻り値の詳細は、detect(PImage)を参照してください。

パラメータ:

i_image - 検出処理を行う画像を指定します。

i_with_loadpixels - PImage.loadPixels()を実行するかのフラグ値です。

関連項目:

detect(PImage)

detect

public void detect(PImageSensor i_source_image)

PImageSensorの内容でインスタンスを更新します。 他のインスタンスで処理したPImageSensorを使うことができます。

パラメータ:

i_source_image -

addNftTarget

public int addNftTarget(java.lang.String i_file_name_prefix,
               int i_page_no,
               float i_target_width)

この関数は、NFTファイルセットからNFTターゲットを生成して登録します。 同じターゲットを複数個登録することはできません。

パラメータ:

i_file_name_prefix - NFTファイルセットの名前を指定します。名前は拡張子を取り除いてください。 例えば"d:\\test"は、"test.iset","test.fset","test.fset3"のファイルセットを登録します。

i_page_no - fset3のページ番号を指定します。

i_target_width - NFTパターンの横幅をmm単位で指定します。

戻り値:

0から始まるマーカーIDを返します。 この数値は、マーカを区別するためのId値です。0から始まり、addNftTarget(java.lang.String, int, float)関数を呼ぶたびにインクリメントされます。 getMatrix(int),isExistTarget(int),addNftTarget(java.lang.String, int, float), #screen2CoordSystem,pickupTargetImage(int, int, int, int, int, int, int, int, int, int, int),pickupRectTargetImage(int, int, int, int, int, int, int) のid値に使います。

addNftTarget

public int addNftTarget(java.lang.String i_file_name_prefix,
               float i_target_width)

この関数は、NFTファイルセットからNFTターゲットを生成して登録します。 addNftTarget(String, int, float)の第二引数に0を設定したものと同じです。

パラメータ:

i_file_name_prefix - addNftTarget(String, int, float)を参照してください。

i_target_width - addNftTarget(String, int, float)を参照してください。

戻り値:

addNftTarget(String, int, float)を参照してください。

addNftTarget

public int addNftTarget(java.lang.String i_file_name_prefix)

この関数は、NFTファイルセットからNFTターゲットを生成して登録します。 NFTターゲット画像のサイズは、ファイルセットのものをそのまま使います。 addNftTarget(String, int, float)の第二引数に0,第三引数にNaNを設定したものと同じです。

パラメータ:

i_file_name_prefix - #addARMarker(String, int, int, double)を参照。

getMatrix

public processing.core.PMatrix3D getMatrix(int i_id)

この関数は、マーカの姿勢行列を返します。 返却した行列はPApplet.setMatrix(processing.core.PMatrix)でProcessingにセットできます。

パラメータ:

i_armk_id - マーカidを指定します。

戻り値:

マーカの姿勢行列を返します。

isExist

public boolean isExist(int i_id)

指定idのターゲットが有効かを返します。

パラメータ:

i_id - マーカidを指定します。

戻り値:

マーカが有効ならばtrueです。無効ならfalseです。

object2ScreenCoordSystem

public processing.core.PVector object2ScreenCoordSystem(int i_id,
                                               double i_x,
                                               double i_y,
                                               double i_z)

この関数は、idで示されるマーカ座標系の点をスクリーン座標へ変換します。

パラメータ:

i_id - マーカidを指定します。

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

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

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

戻り値:

スクリーン座標

screen2ObjectCoordSystem

public processing.core.PVector screen2ObjectCoordSystem(int i_id,
                                               int i_x,
                                               int i_y)

この関数は、スクリーン座標をidで指定したマーカ平面座標へ変換して返します。

パラメータ:

i_id - マーカidを指定します。

i_x - スクリーン座標を指定します。

i_y - スクリーン座標を指定します。

戻り値:

マーカ平面上の座標点です。

pickupImage

public processing.core.PImage pickupImage(int i_id,
                                 int i_x1,
                                 int i_y1,
                                 int i_x2,
                                 int i_y2,
                                 int i_x3,
                                 int i_y3,
                                 int i_x4,
                                 int i_y4,
                                 int i_out_w_pix,
                                 int i_out_h_pix)

この関数は、idで指定したマーカの画像のXY平面上の4頂点でかこまれた領域から、画像を取得します。 取得元画像には、最後にdetect(processing.core.PImage)関数に入力した画像を使います。 座標点は、[mm]単位です。出力解像度はo_outの解像度に伸縮します。 座標点の指定順序は、右手系#CS_RIGHT_HANDなら右上から反時計回りです。 座標点の指定順序は、左手系#CS_LEFT_HANDなら左上から時計回りです。

パラメータ:

i_id - マーカIdを指定します。

i_x1 - 頂点座標1です。

i_y1 - 頂点座標1です。

i_x2 - 頂点座標2です。

i_y2 - 頂点座標2です。

i_x3 - 頂点座標3です。

i_y3 - 頂点座標3です。

i_x4 - 頂点座標4です。

i_y4 - 頂点座標4です。

i_out_w_pix - 出力画像のピクセル幅です。

i_out_h_pix - 出力画像のピクセル高さです。

戻り値:

取得したパターンを返します。

pickupRectImage

public processing.core.PImage pickupRectImage(int i_id,
                                     int i_l,
                                     int i_t,
                                     int i_w,
                                     int i_h,
                                     int i_out_w_pix,
                                     int i_out_h_pix)

この関数は、idで指定したマーカのXY平面上の矩形領域から、画像を取得します。 座標点は、[mm]単位です。出力は、o_outの解像度に伸縮します。

パラメータ:

i_id - 画像を指定します。

i_l - 左上の点を指定します。

i_t - 左上の点を指定します。

i_w - 矩形の幅を指定します。

i_h - 矩形の高さを指定します。

i_out_w_pix - 出力画像のピクセル幅です。

i_out_h_pix - 出力画像のピクセル高さです。

戻り値:

取得したパターンを返します。

isExistTarget

@Deprecated
public boolean isExistTarget(int i_id)

非推奨です。

isExist(int)のエイリアスです。

パラメータ:

i_id -

戻り値:

getTargetMatrix

@Deprecated
public processing.core.PMatrix3D getTargetMatrix(int i_id)

非推奨です。

getMatrix(int)のエイリアスです。

パラメータ:

i_id -

戻り値:

pickupTargetImage

@Deprecated
public processing.core.PImage pickupTargetImage(int i_id,
                                                  int i_x1,
                                                  int i_y1,
                                                  int i_x2,
                                                  int i_y2,
                                                  int i_x3,
                                                  int i_y3,
                                                  int i_x4,
                                                  int i_y4,
                                                  int i_out_w_pix,
                                                  int i_out_h_pix)

非推奨です。

pickupImage(int, int, int, int, int, int, int, int, int, int, int)のエイリアスです。

pickupRectTargetImage

@Deprecated
public processing.core.PImage pickupRectTargetImage(int i_id,
                                                      int i_l,
                                                      int i_t,
                                                      int i_w,
                                                      int i_h,
                                                      int i_out_w_pix,
                                                      int i_out_h_pix)

非推奨です。

pickupRectImage(int, int, int, int, int, int, int)のエイリアスです。

screen2TargetCoordSystem

@Deprecated
public processing.core.PVector screen2TargetCoordSystem(int i_id,
                                                          int i_x,
                                                          int i_y)

非推奨です。

screen2ObjectCoordSystem(int, int, int)のエイリアスです。

target2ScreenCoordSystem

@Deprecated
public processing.core.PVector target2ScreenCoordSystem(int i_id,
                                                          double i_x,
                                                          double i_y,
                                                          double i_z)

非推奨です。

{link #object2ScreenCoordSystem}のエイリアスです。

dispose

public void dispose()

Processing callback function インスタンスが起動したマルチスレッドを終了時に停止します。