ARToolkitの関数の意味覚書「ar*」編

ARToolkitのドキュメントを読み解く

まあ読み解いた結果を一応ここにも。
一度データ吹っ飛んで書きなおしたので、それ予防ということで。
皆様もバックアップは取りましょう……。

注意

個人的解釈なので間違っている可能性は多大にあります。
間違っていた場合、出来ればコメントなどでの指摘をお願いします。

int arVideoOpen(char* config)

概要
　引数で指定したカメラの設定ファイルを読み込み、ストリームを用意する。
引数
　char* config : カメラの設定ファイルのパス
返却値
　0 : 成功
　-1 : 失敗(設定ファイルが読み込めない、構造がおかしいなど)
場所
　AR/video.h
関連
　arVideoClose() : ビデオを停止する。
　arVideoCapStart() : ビデオキャプチャを開始する。

int arVideoClose(void)

概要
　ビデオのストリームを停止する。
返却値
　0 : 成功
　-1 : 失敗
場所
　AR/video.h
関連
　arVideoOpen() : ビデオを開始する。

int arVideoInqSize(int* xsize, int* ysize)

概要
　カメラの解像度を取得する。
引数
　int* xsize : 解像度のx方向の長さ
　int* ysize : 解像度のy方向の長さ
返却値
　0 : 成功
　-1 : 失敗
場所
　AR/video.h

int arParamLoad(const char* filename, int num, ARParam* param, ...)

概要
　カメラの固有パラメータファイルを読み込む。
引数
　const char* filename : カメラの固有パラメータが記述されたファイルパス
　int num : パラメータ格納変数の個数
　ARParam* param : 読み込まれたパラメータを格納する変数
返却値
　0 : 成功
　-1 : 失敗
場所
　AR/param.h

int arParamChangeSize(ARParam* source, int xsize, int ysize, ARParam* newparam)

概要
　カメラの固有パラメータに解像度を設定し、その結果を変数に格納する。
引数
　ARParam* source : カメラの固有パラメータ
　int* xsize : 解像度のx方向の長さ
　int* ysize : 解像度のy方向の長さ
　ARParam* newparam : 結果の格納変数
返却値
　常に0
場所
　AR/param.h

int arInitCparam(ARParam* param)

概要
　引数で指定したパラメータによりカメラを初期化する。
引数
　ARParam* param : 初期化したいカメラパラメータ
返却値
　常に0
関連
　AR/param.h

int arVideoCapStart(void)

概要
　ビデオキャプチャを開始する
返却値
　0 : 成功
　-1 : 失敗
場所
　AR/video.h
関連
　arVideoOpen() : ビデオを開始する。
　arVideoCapStop() : ビデオキャプチャを終了する。

int arVideoCapStop(void)

概要
　ビデオキャプチャを停止する。
返却値
　0 : 成功
　-1 : 失敗
場所
　AR/video.h
関連
　arVideoCapStart() : ビデオキャプチャを開始する。

int arParamDisp(ARParam* param)

概要
　引数で指定したパラメータを表示する。
引数
　ARParam* param : 確認したいパラメータ変数
返却値
　常に0
場所
　AR/param.h

int arLoadPatt(const char *filename)

概要
　引数で指定されたマーカーパターンファイルを読み込む。
引数
　const char* filename : マーカーパターンファイルのパス
返却値
　成功：パターンのID
　失敗：-1
場所
　AR/ar.h

ARUint8* arVideoGetImage(void)

概要
　キャプチャした画像を取得する。
返却値
　キャプチャした画像の先頭ポインタ
場所
　AR/video.h

int arVideoCapNext()

概要
　次のキャプチャ画像を呼び出す。
　これはarVideoGetImage()の直後に呼び出すことが好ましい。
返却値
　0 : 成功
　-1 : 失敗
場所
　AR/video.h

void arUtilSleep(int msec)

概要
　引数で指定したミリ秒間スレッドを停止させる。
引数
　int msec : 停止させたい時間(単位:ミリ秒)
場所
　AR/ar.h

void arUtilTimerReset(void)

概要
　ARToolkit内部の時計をリセットする。
　フレームレートの計算などに用いることができる？
場所
　AR/ar.h

int arDetectMarker(ARUint8* dataPtr, int thresh, ARMarkerInfo** marker_info, int* marker_num)

概要
　バッファの画像からマーカーを検出する。
　この関数内部でバイナリ画像化される。
引数
　ARUint8* dataPtr : マーカーを検出したい画像
　int thresh : バイナリ画像化する際のしきい値
　ARMarkerInfo** marker_info : 検出されたマーカーの格納変数
　int* marker_num : 検出されたマーカーの個数の格納変数
返却値
　正常終了：0
　異常終了：-1
場所
　AR/ar.h

int arGetTransMat(ARMarkerInfo* marker_info, double center[2], double width, double conv[3][4])

概要
　マーカー座標系をカメラ座標系に変換する変換行列を取得する。
引数
　ARMarkerInfo* marker_info : 検出されたマーカーの詳細情報
　double center[2] : マーカーのカメラ座標系での中心座標(xy平面上)？
　double width : マーカーの物理的大きさ(ARToolkitの場合正方形なので一辺の長さ。単位:mm)
　double conv[3][4] : 変換行列を格納する変数
返却値
　常に0
場所
　AR/ar.h

一先ずここまで

他の関数についてもまとめたら掲載します。
なお、gsub関係はまた別のページに。