[NyARToolKit for java]update document

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / match / NyARMatchPattDeviationBlackWhiteData.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/match/NyARMatchPattDeviationBlackWhiteData.java b/lib/src/jp/nyatla/nyartoolkit/core/match/NyARMatchPattDeviationBlackWhiteData.java
index 65cf3c1..feddad3 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/match/NyARMatchPattDeviationBlackWhiteData.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/match/NyARMatchPattDeviationBlackWhiteData.java
@@ -32,11 +32,16 @@ package jp.nyatla.nyartoolkit.core.match;
 \r
 \r
 import jp.nyatla.nyartoolkit.core.raster.*;\r
+import jp.nyatla.nyartoolkit.core.types.*;\r
 \r
 \r
 /**\r
- * INyARMatchPattのColor差分ラスタを格納するクラスです。\r
- *\r
+ * このクラスは、グレースケールの差分画像を格納します。\r
+ * 差分画像は、p[i]=((255-画素[i])-画像全体の平均値)のピクセルで構成されている、平均値との差分値です。\r
+ * {@link NyARMatchPatt_BlackWhite}の入力値と使います。\r
+ * <p>使い方 - \r
+ * {@link #setRaster}関数で、差分画像を作成し、プロパティ取得関数でその情報を得ます。\r
+ * </p>\r
  */\r
 public class NyARMatchPattDeviationBlackWhiteData\r
 {\r
@@ -44,15 +49,32 @@ public class NyARMatchPattDeviationBlackWhiteData
        private double _pow;\r
        //\r
        private int _number_of_pixels;\r
+       /**\r
+        * この関数は、画素データを格納した配列を返します。\r
+        * {@link NyARMatchPatt_BlackWhite#evaluate}関数から使います。\r
+        */\r
        public int[] refData()\r
        {\r
                return this._data;\r
        }\r
+       /**\r
+        * この関数は、差分画像の強度値を返します。\r
+        * 強度値は、差分画像の画素を二乗した値の合計です。\r
+        * @return\r
+        * 0&lt;nの強度値。\r
+        */\r
        public double getPow()\r
        {\r
                return this._pow;\r
        }\r
-                         \r
+       /**\r
+        * コンストラクタです。\r
+        * 差分画像のサイズを指定して、インスタンスを生成します。\r
+        * @param i_width\r
+        * 差分画像のサイズ\r
+        * @param i_height\r
+        * 差分画像のサイズ\r
+        */\r
        public NyARMatchPattDeviationBlackWhiteData(int i_width,int i_height)\r
        {\r
                this._number_of_pixels=i_height*i_width;\r
@@ -60,8 +82,10 @@ public class NyARMatchPattDeviationBlackWhiteData
                return;\r
        }\r
        /**\r
-        * XRGB[width*height]の配列から、パターンデータを構築。\r
-        * @param i_buffer\r
+        * この関数は、ラスタから差分画像を生成して、格納します。\r
+        * 制限事項として、{@link NyARBufferType#INT1D_X8R8G8B8_32}形式のラスタのみ、入力できます。\r
+        * @param i_raster\r
+        * 差分画像の元画像。サイズは、このインスタンスと同じである必要があります。\r
         */\r
        public void setRaster(INyARRaster i_raster)\r
        {\r