root/lang/cpluspluscli/OpenCvSharp2/trunk/OpenCvSharp/Src/Class/CvHaarClassifierCascade.cs @ 32668

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace KwsmLab.OpenCvSharp
{
#if LANG_JP
    /// <summary>
    /// 段階分類器のカスケードまたは木
    /// </summary>
#else
    /// <summary>
    /// Cascade or tree of stage classifiers
    /// </summary>
#endif
    public class CvHaarClassifierCascade : DisposableObject, ICvPtrHolder
    {
        /// <summary>
        /// C++/CLI wrapper of data pointer
        /// </summary>
        private Extern.WCvHaarClassifierCascade _data;
        /// <summary>
        /// Data pointer
        /// </summary>
        private IntPtr _ptr;


        #region Init and Disposal
#if LANG_JP
        /// <summary>
        /// ポインタで初期化
        /// </summary>
        /// <param name="ptr">struct CvHaarClassifierCascade*</param>
#else
        /// <summary>
        /// Initializes from native pointer
        /// </summary>
        /// <param name="ptr"></param>
#endif
        public CvHaarClassifierCascade(IntPtr ptr)
            : this(ptr, true)
        {
        }
        /// <summary>
        /// ポインタと自動解放の可否を指定して初期化
        /// </summary>
        /// <param name="ptr">struct CvHaarClassifierCascade*</param>
        /// <param name="isEnabledDispose">自動的にGCで解放してよいかどうか</param>
        internal CvHaarClassifierCascade(IntPtr ptr, bool isEnabledDispose)
            : base(isEnabledDispose)
        {
            if (ptr == IntPtr.Zero)
            {
                throw new OpenCvSharpException("CvHaarClassifierCascadeの生成に失敗しました。");
            }
            this._ptr = ptr;
            this._data = new Extern.WCvHaarClassifierCascade(ptr);
        }
#if LANG_JP
            /// <summary>
            /// ファイルからHaar分類機のカスケードを読み込んで返す (cvLoad相当).
            /// </summary>
            /// <param name="filename">読み込むファイル(xml/yaml)</param>
            /// <returns>CvHaarClassifierCascade</returns>
#else
        /// <summary>
        /// Loads object from file
        /// </summary>
        /// <param name="filename">File name (xml/yaml)</param>
        /// <returns></returns>
#endif
            public static CvHaarClassifierCascade FromFile( string filename )
            {
            if (string.IsNullOrEmpty(filename))
            {
                throw new OpenCvSharpException("CvHaarClassifierCascadeの生成に失敗しました。");
            }
                    return Cv.Load<CvHaarClassifierCascade>(filename);
            }

#if LANG_JP
        /// <summary>
        /// リソースの解放 (cvReleaseHaarClassifierCascade)
        /// </summary>
#else
        /// <summary>
        /// Releases using cvReleaseHaarClassifierCascade
        /// </summary>
#endif
        public override void Dispose()
        {
            if (IsEnabledDispose && !IsDisposed)
            {
                CvDll.cvReleaseHaarClassifierCascade(ref _ptr);                
            }
            base.Dispose();
        }
        #endregion


        #region Properties
        /// <summary>
        /// Data pointer (CvHaarClassifierCascade*)
        /// </summary>
        public IntPtr CvPtr
        {
            get { return _ptr; }
        }
        /// <summary>
        /// sizeof(CvHaarClassifierCascade) 
        /// </summary>
        public const Int32 SizeOf = Extern.WCvHaarClassifierCascade.SizeOf;


#if LANG_JP
        /// <summary>
        /// シグネチャ
        /// </summary>
#else
        /// <summary>
        /// Signature 
        /// </summary>
#endif
        public int Flags
        {
            get { return _data.flags; }
        }
#if LANG_JP
        /// <summary>
        /// 段階数
        /// </summary>
#else
        /// <summary>
        /// Number of stages
        /// </summary>
#endif
        public int Count
        {
            get { return _data.count; }
        }
#if LANG_JP
        /// <summary>
        /// オリジナルのオブジェクトサイズ（カスケードの学習対象）
        /// </summary>
#else
        /// <summary>
        /// Original object size (the cascade is trained for)
        /// </summary>
#endif
        public CvSize OrigWindowSize
        {
            get { return _data.orig_window_size; }
        }
#if LANG_JP
        /// <summary>
        /// 現在のオブジェクトサイズ
        /// </summary>
#else
        /// <summary>
        /// Current object size
        /// </summary>
#endif
        public CvSize RealWindowSize
        {
            get { return _data.real_window_size; }
        }
#if LANG_JP
        /// <summary>
        /// 現在のスケール
        /// </summary>
#else
        /// <summary>
        /// Current scale
        /// </summary>
#endif
        public double Scale
        {
            get { return _data.scale; }
        }
#if LANG_JP
        /// <summary>
        /// 段階分類器の配列
        /// </summary>
#else
        /// <summary>
        /// Array of stage classifiers
        /// </summary>
#endif
        public CvHaarStageClassifier[] StageClassifier
        {
            get
            {
                int length = _data.count;
                CvHaarStageClassifier[] result = new CvHaarStageClassifier[length];
                for (int i = 0; i < length; i++)
                {
                    result[i] = new CvHaarStageClassifier(_data.stage_classifier_at(i));
                }
                return result;
            }
        }
#if LANG_JP
        /// <summary>
        /// cvSetImagesForHaarClassifierCascade によって生成されるカスケードの，隠れ最適表現
        /// </summary>
#else
        /// <summary>
        /// Hidden optimized representation of the cascade, created by cvSetImagesForHaarClassifierCascade
        /// </summary>
#endif
        public IntPtr HidCascade
        {
            get { return _data.hid_cascade; }
        }

        #endregion


        #region メソッド
        #region HaarDetectObjects
        /// <summary>
        /// 与えられた画像からオブジェクトを含む様な矩形領域を検出し，それらの領域を矩形の列として返す．
        /// </summary>
        /// <param name="image">この画像の中からオブジェクトを検出する</param>
        /// <param name="storage">オブジェクト候補の矩形が得られた場合に，その矩形列を保存するメモリストレージ</param>
        /// <returns>CvRectを要素とするCvSeq</returns>
        public CvSeq HaarDetectObjects(CvArr image, CvMemStorage storage)
        {
            return Cv.HaarDetectObjects(image, this, storage);
        }
        /// <summary>
        /// 与えられた画像からオブジェクトを含む様な矩形領域を検出し，それらの領域を矩形の列として返す．
        /// </summary>
        /// <param name="image">この画像の中からオブジェクトを検出する</param>
        /// <param name="storage">オブジェクト候補の矩形が得られた場合に，その矩形列を保存するメモリストレージ</param>
        /// <param name="scale_factor">スキャン毎に探索ウィンドウがスケーリングされる際のスケールファクタ． 例えばこの値が 1.1 ならば，ウィンドウが 10% 大きくなる</param>
        /// <returns>CvRectを要素とするCvSeq</returns>
        public CvSeq HaarDetectObjects(CvArr image, CvMemStorage storage, double scale_factor)
        {
            return Cv.HaarDetectObjects(image, this, storage, scale_factor);
        }
        /// <summary>
        /// 与えられた画像からオブジェクトを含む様な矩形領域を検出し，それらの領域を矩形の列として返す．
        /// </summary>
        /// <param name="image">この画像の中からオブジェクトを検出する</param>
        /// <param name="storage">オブジェクト候補の矩形が得られた場合に，その矩形列を保存するメモリストレージ</param>
        /// <param name="scale_factor">スキャン毎に探索ウィンドウがスケーリングされる際のスケールファクタ． 例えばこの値が 1.1 ならば，ウィンドウが 10% 大きくなる</param>
        /// <param name="min_neighbors">（これから 1 を引いた値が）オブジェクトを構成する近傍矩形の最小数となる． min_neighbors-1 よりも少ない矩形しか含まないようなグループは全て棄却される． もし min_neighbors が 0 である場合，この関数はグループを一つも生成せず，候補となる矩形を全て返す．これはユーザがカスタマイズしたグループ化処理を適用したい場合に有用である． </param>
        /// <returns>CvRectを要素とするCvSeq</returns>
        public CvSeq HaarDetectObjects(CvArr image, CvMemStorage storage, double scale_factor, int min_neighbors)
        {
            return Cv.HaarDetectObjects(image, this, storage, scale_factor, min_neighbors);
        }
        /// <summary>
        /// 与えられた画像からオブジェクトを含む様な矩形領域を検出し，それらの領域を矩形の列として返す．
        /// </summary>
        /// <param name="image">この画像の中からオブジェクトを検出する</param>
        /// <param name="storage">オブジェクト候補の矩形が得られた場合に，その矩形列を保存するメモリストレージ</param>
        /// <param name="scale_factor">スキャン毎に探索ウィンドウがスケーリングされる際のスケールファクタ． 例えばこの値が 1.1 ならば，ウィンドウが 10% 大きくなる</param>
        /// <param name="min_neighbors">（これから 1 を引いた値が）オブジェクトを構成する近傍矩形の最小数となる． min_neighbors-1 よりも少ない矩形しか含まないようなグループは全て棄却される． もし min_neighbors が 0 である場合，この関数はグループを一つも生成せず，候補となる矩形を全て返す．これはユーザがカスタマイズしたグループ化処理を適用したい場合に有用である． </param>
        /// <param name="flags">処理モード</param>
        /// <returns>CvRectを要素とするCvSeq</returns>
        public CvSeq HaarDetectObjects(CvArr image, CvMemStorage storage, double scale_factor, int min_neighbors, HaarDetectionType flags)
        {
            return Cv.HaarDetectObjects(image, this, storage, scale_factor, min_neighbors, flags);
        }
        /// <summary>
        /// 与えられた画像からオブジェクトを含む様な矩形領域を検出し，それらの領域を矩形の列として返す．
        /// </summary>
        /// <param name="image">この画像の中からオブジェクトを検出する</param>
        /// <param name="storage">オブジェクト候補の矩形が得られた場合に，その矩形列を保存するメモリストレージ</param>
        /// <param name="scale_factor">スキャン毎に探索ウィンドウがスケーリングされる際のスケールファクタ． 例えばこの値が 1.1 ならば，ウィンドウが 10% 大きくなる</param>
        /// <param name="min_neighbors">（これから 1 を引いた値が）オブジェクトを構成する近傍矩形の最小数となる． min_neighbors-1 よりも少ない矩形しか含まないようなグループは全て棄却される． もし min_neighbors が 0 である場合，この関数はグループを一つも生成せず，候補となる矩形を全て返す．これはユーザがカスタマイズしたグループ化処理を適用したい場合に有用である． </param>
        /// <param name="flags">処理モード</param>
        /// <param name="min_size">最小ウィンドウサイズ．デフォルトでは分類器の学習に用いられたサンプルのサイズが設定される（顔検出の場合は，~20×20）.</param>
        /// <returns>CvRectを要素とするCvSeq</returns>
        public CvSeq HaarDetectObjects(CvArr image, CvMemStorage storage, double scale_factor, int min_neighbors, HaarDetectionType flags, CvSize min_size)
        {
            return Cv.HaarDetectObjects(image, this, storage, scale_factor, min_neighbors, flags, min_size);
        }
        #endregion
        #region Run
            /// <summary>
            /// ブーストされた分類器のカスケードを，与えられた画像位置で実行する (cvRunHaarClassifierCascade相当)
            /// </summary>
            /// <param name="pt">解析する領域の左上の角</param>
            /// <returns>分析対象の領域が全ての分類器ステージを通過した場合（これは候補の一つになる）はtrue，そうでなければfalse．</returns>
            public bool Run( CvPoint pt )
            {
                    return Cv.RunHaarClassifierCascade(this, pt);
            }
            /// <summary>
            /// ブーストされた分類器のカスケードを，与えられた画像位置で実行する (cvRunHaarClassifierCascade相当)
            /// </summary>
            /// <param name="pt">解析する領域の左上の角</param>
            /// <param name="start_stage">0から始まるインデックスで，カスケードステージをどこ から開始するかを決定する</param>
            /// <returns>分析対象の領域が全ての分類器ステージを通過した場合（これは候補の一つになる）はtrue，そうでなければfalse．</returns>
            public bool Run( CvPoint pt, bool start_stage )
            {
                    return Cv.RunHaarClassifierCascade(this, pt, start_stage);
            }
            #endregion 
            #region SetImages
            /// <summary>
            /// 画像を隠れ分類器カスケードに割り当てる (cvSetImagesForHaarClassifierCascade相当)．
            /// </summary>
            /// <param name="sum">32 ビット整数シングルチャンネルのインテグラルイメージ．</param>
            /// <param name="sqsum">64ビット浮動小数点型のシングルチャンネル画像の各ピクセルを二乗した値に対するインテグラルイメージ．</param>
            /// <param name="tilted_sum">32 ビット整数型のシングルチャンネル画像を 45°傾けたものに対するインテグラルイメージ．</param>
            /// <param name="scale">カスケードのウィンドウスケール</param>
            public void SetImages( CvArr sum, CvArr sqsum, CvArr tilted_sum, double scale )
            {
                    Cv.SetImagesForHaarClassifierCascade(this, sum, sqsum, tilted_sum, scale);
            }
            #endregion 
        #endregion
    }
}