-package jp.nyatla.nyartoolkit.dev.rpf.sampler.lrlabel;\r
+package jp.nyatla.nyartoolkit.rpf.sampler.lrlabel;\r
\r
import jp.nyatla.nyartoolkit.NyARException;\r
import jp.nyatla.nyartoolkit.core.types.NyARIntPoint2d;\r
import jp.nyatla.nyartoolkit.core.utils.NyARManagedObjectPool;\r
\r
/**\r
- * LowResolutionLabelingSampler用の出力コンテナです。サンプリング結果を受け取ります。\r
- * 内容には、AreaDataItemの集合を持ちます。\r
- * AreaDataItemは元画像に対する、Labeling結果と元画像の情報のセットです。\r
+ * このクラスは、{@link LowResolutionLabelingSampler}の結果を受け取るコンテナです。\r
+ * ラベルリストを所有します。\r
*/\r
public class LowResolutionLabelingSamplerOut\r
{\r
/**\r
- * クラス内定義ができない処理系では、LowResolutionLabelingSamplerOutItemで定義してください。\r
+ * ラべリング結果を格納するデータクラスです。\r
+ * <p> メモ - クラス内定義ができない処理系では、LowResolutionLabelingSamplerOutItemで定義してください。</p>\r
*\r
*/\r
public class Item extends NyARManagedObject\r
{\r
- /**\r
- * ラべリング対象のエントリポイントです。\r
- */\r
+ /** 輪郭のエントリポイントです。*/\r
public NyARIntPoint2d entry_pos=new NyARIntPoint2d();\r
- /**\r
- * ラべリング対象の範囲を、トップレベル換算した値です。クリップ情報から計算されます。\r
- */\r
+ /** ラべルのクリップ範囲を、元画像の解像度に換算した値です。*/\r
public NyARIntRect base_area =new NyARIntRect();\r
- /**\r
- * ラべリング対象の範囲中心を、トップレベルに換算した値です。クリップ情報から計算されます。\r
- */\r
+ /** ラベルのクリップ範囲の中心を、元画像の解像度に換算した値です。*/\r
public NyARIntPoint2d base_area_center=new NyARIntPoint2d();\r
- /**\r
- * エリア矩形の対角距離の2乗値\r
- */\r
+ /** ラベル範囲矩形の、対角距離の2乗値です。*/\r
public int base_area_sq_diagonal;\r
- \r
+ /** ラベルを検出した時の閾値です。*/\r
public int lebeling_th;\r
- \r
+ /**\r
+ * コンストラクタです。\r
+ * @param i_pool\r
+ * 親プールのコントロールインタフェイス。\r
+ */\r
public Item(INyARManagedObjectPoolOperater i_pool)\r
{\r
super(i_pool);\r
} \r
/**\r
* AreaのPoolクラス\r
- *\r
*/\r
private class AreaPool extends NyARManagedObjectPool<Item>\r
{\r
}\r
/**\r
* AreaのStackクラス\r
- *\r
*/\r
private class AreaStack extends NyARPointerStack<Item>\r
{\r
super.initInstance(i_length, Item.class);\r
}\r
}\r
- /**\r
- * 元\r
- */\r
+\r
private AreaPool _pool;\r
private AreaStack _stack;\r
-\r
+ /**\r
+ * コンストラクタです。\r
+ * 格納出来るラベルの最大値を指定して、インスタンスを生成します。\r
+ * @param i_length\r
+ * 格納するラベルの最大値\r
+ * @throws NyARException\r
+ */\r
public LowResolutionLabelingSamplerOut(int i_length) throws NyARException\r
{\r
this._pool=new AreaPool(i_length);\r
return;\r
}\r
/**\r
- * Samplerが使う関数です。ユーザは通常使用しません。\r
- * SamplerOutの内容を初期状態にします。\r
- * @param i_source\r
+ * この関数は、インスタンスを初期化します。\r
+ * {@link LowResolutionLabelingSampler}が使う関数です。ユーザが使用することはありません。\r
*/\r
public void initializeParams()\r
{\r
//スタックをクリア\r
this._stack.clear();\r
}\r
+ /**\r
+ * この関数は、新しいラベル要素を1個割り当てます。\r
+ * 通常、ユーザが使用することはありません。\r
+ * @return\r
+ * 割り当てられたラベルオブジェクト。失敗するとNULL\r
+ * @throws NyARException\r
+ */\r
public Item prePush() throws NyARException\r
{\r
Item result=this._pool.newObject();\r
\r
}\r
/**\r
- * 検出したエリアデータの配列を返します。\r
+ * この関数は、ラベル配列の参照値を返します。\r
+ * 有効な個数は、{@link #getLength}で得られます。\r
* @return\r
+ * ラベル配列の参照値。\r
*/\r
public Item[] getArray()\r
{\r
return this._stack.getArray();\r
}\r
/**\r
- * 検出したエリアデータの総数を返します。\r
+ * この関数は、有効なラベル配列の要素数を返します。\r
* @return\r
+ * 有効な要素数。\r
*/\r
public int getLength()\r
{\r
OSDN Git Service
