git-svn-id: http://svn.sourceforge.jp/svnroot/nyartoolkit/NyARToolkit/trunk@803 7cac0...

[nyartoolkit-and/nyartoolkit-and.git] / lib / src / jp / nyatla / nyartoolkit / core / types / NyARHistogram.java

diff --git a/lib/src/jp/nyatla/nyartoolkit/core/types/NyARHistogram.java b/lib/src/jp/nyatla/nyartoolkit/core/types/NyARHistogram.java
index 6d0293a..c27ab3f 100644 (file)
--- a/lib/src/jp/nyatla/nyartoolkit/core/types/NyARHistogram.java
+++ b/lib/src/jp/nyatla/nyartoolkit/core/types/NyARHistogram.java
@@ -30,26 +30,34 @@
  */\r
 package jp.nyatla.nyartoolkit.core.types;\r
 \r
+\r
 /**\r
- * ã\83\92ã\82¹ã\83\88ã\82°ã\83©ã\83 ã\82\92æ ¼ç´\8dã\81\99ã\82\8bã\82¯ã\83©ã\82¹ã\81§ã\81\99ã\80\82\r
+ * ã\81\93ã\81®ã\82¯ã\83©ã\82¹ã\81¯ã\80\81ã\83\92ã\82¹ã\83\88ã\82°ã\83©ã\83 ã\82\92æ ¼ç´\8dã\81\99ã\82\8bã\83\87ã\83¼ã\82¿å\9e\8b\r
  */\r
 public class NyARHistogram\r
 {\r
-       /**\r
-        * サンプリング値の格納変数\r
+       /** ヒストグラムを格納する配列です。\r
+        * <p>注意 - 配列の長さ({@link #data})と{@link #length}の意味は異なります。\r
+        * ヒストグラムの解像度に、この配列の長さを使わないでください。</p>\r
         */\r
        public final int[] data;\r
-       /**\r
-        * 有効なサンプリング値の範囲。[0-data.length-1]\r
+       /** ヒストグラムの解像度です。\r
+        * {@link #data}配列の0から{@link #length}-1までの要素が、アクセス可能な要素です。\r
         */\r
        public int length;\r
        /**\r
-        * 有効なサンプルの総数 data[i]\r
+        * ヒストグラムの合計値です。\r
+        * ヒストグラム分析器は、ここにヒストグラム要素の合計値を書込みます。\r
         */\r
        public int total_of_data;\r
        \r
        \r
-       \r
+       /**\r
+        * コンストラクタです。\r
+        * ヒストグラムの解像度を指定してインスタンスを作ります。\r
+        * @param i_length\r
+        * ヒストグラムの解像度値。通常は256を指定してください。\r
+        */\r
        public NyARHistogram(int i_length)\r
        {\r
                this.data=new int[i_length];\r
@@ -57,10 +65,13 @@ public class NyARHistogram
                this.total_of_data=0;\r
        }\r
        /**\r
-        * 区間i_stからi_edまでの総データ数を返します。\r
+        * この関数は、ヒストグラム要素の、i_stからi_edまでの区間の、合計値を返します。\r
         * @param i_st\r
+        * 集計開始点のインデクス\r
         * @param i_ed\r
+        * 集計終了点のインデクス\r
         * @return\r
+        * ヒストグラムの合計値\r
         */\r
        public final int getTotal(int i_st,int i_ed)\r
        {\r
@@ -73,8 +84,10 @@ public class NyARHistogram
                return result;\r
        }\r
        /**\r
-        * 指定したi_pos未満サンプルを０にします。\r
+        * この関数は、指定したインデクス以下のヒストグラム要素を0にします。\r
+        *　実行結果は、{@link #total_of_data}に反映されます。\r
         * @param i_pos\r
+        * 操作するヒストグラム要素のインデクス値。\r
         */\r
        public void lowCut(int i_pos)\r
        {\r
@@ -86,8 +99,10 @@ public class NyARHistogram
                this.total_of_data-=s;\r
        }\r
        /**\r
-        * 指定したi_pos以上のサンプルを０にします。\r
+        * この関数は、指定したインデクス以上のヒストグラム要素を0にします。\r
+        *　実行結果は、{@link #total_of_data}に反映されます。\r
         * @param i_pos\r
+        * 操作するヒストグラム要素のインデクス値。\r
         */\r
        public void highCut(int i_pos)\r
        {\r
@@ -99,7 +114,9 @@ public class NyARHistogram
                this.total_of_data-=s;\r
        }\r
        /**\r
-        * 最小の値が格納されているサンプル番号を返します。\r
+        * この関数は、ヒストグラム要素の中で最小の要素のインデクス番号を返します。\r
+        * @return\r
+        * 最小要素のインデクス番号\r
         */\r
        public int getMinSample()\r
        {\r
@@ -116,16 +133,18 @@ public class NyARHistogram
                return ret;\r
        }\r
        /**\r
-        * ã\82µã\83³ã\83\97ã\83«ã\81®ä¸­ã\81§æ\9c\80å°\8fã\81®値を返します。\r
+        * ã\81\93ã\81®é\96¢æ\95°ã\81¯ã\80\81ã\83\92ã\82¹ã\83\88ã\82°ã\83©ã\83 è¦\81ç´ ã\81®ä¸­ã\81§æ\9c\80å°\8fã\81®è¦\81ç´ 値を返します。\r
         * @return\r
+        * 最小要素の値\r
         */\r
        public int getMinData()\r
        {\r
                return this.data[this.getMinSample()];\r
        }\r
        /**\r
-        * 平均値を計算します。\r
+        * この関数は、ヒストグラム要素全体の平均値を計算します。\r
         * @return\r
+        * ヒストグラム要素の平均値\r
         */\r
        public int getAverage()\r
        {\r