EstimationConfig.h

// EstimationConfig.h:
// -------------------
//

#ifndef __IPSDKMATH_ESTIMATIONCONFIG_H__
#define __IPSDKMATH_ESTIMATIONCONFIG_H__

// suppression warnings
// warning C4251: 'ipsdk::math::EstimationConfig::_robustEstimationType': class 'ipsdk::math::eRobustEstimationType' needs to have dll-interface to be used by clients of class 'ipsdk::math::EstimationConfig'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKMath/IPSDKMathExports.h>
#include <IPSDKMath/Estimation/EstimationTypes.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>

namespace ipsdk {
namespace math {


class IPSDKMATH_API EstimationConfig : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKMath, EstimationConfig)

public:
    EstimationConfig();
    ~EstimationConfig();

// methods
public:
    bool                            isInit() const;

    //------------------------------
    //------------------------------

    void                            initNonRobust();

    void                            initLMS(const ipReal64 expectedOutlierRatio = 0.4);

    void                            initRANSAC(const ipReal64 outlierThreshold,
                                               const ipReal64 expectedOutlierRatio = 0.4);

    void                            initMSAC(const ipReal64 outlierThreshold,
                                             const ipReal64 expectedOutlierRatio = 0.4);

    void                            initMLESAC(const ipReal64 gaussianSigma,
                                               const ipReal64 outlierThresholdFactor = 3,
                                               const ipReal64 outlierRangeFactor = 10,
                                               const ipReal64 expectedOutlierRatio = 0.4);

    const eRobustEstimationType&    getRobustEstimationType() const;

    ipReal64                        getOutlierThreshold() const;

    ipReal64                        getGaussianSigma() const;

    ipReal64                        getOutlierThresholdFactor() const;

    ipReal64                        getOutlierRangeFactor() const;

    ipReal64                        getExpectedOutlierRatio() const;

    void                            setAllowSimpleEstimation(const bool bAllowSimpleEstimation);
    bool                            getAllowSimpleEstimation() const;

    void                            setSuccessRatio(const ipReal64 successRatio);

    ipReal64                        getSuccessRatio() const;

    void                            setDataPartition(const DataPartitionPtr& pDataPartition);

    void                            setAdaptiveGridPartition();
    void                            setAdaptiveGridPartition(const ipUInt32 nbBucketsByAxis);

    void                            setRegularGridPartition();
    void                            setRegularGridPartition(const ipUInt32 nbBucketsByAxis);

    DataPartitionPtr                getDataPartitionPtr() const;

    void                            clear();

// attributes
protected:
    bool                    _bInit;

    eRobustEstimationType   _robustEstimationType;

    ipReal64                _outlierThreshold;

    ipReal64                _gaussianSigma;

    ipReal64                _outlierRangeFactor;

    ipReal64                _expectedOutlierRatio;

    bool                    _bAllowSimpleEstimation;

    ipReal64                _successRatio;

    DataPartitionPtr        _pDataPartition;
};


inline bool
EstimationConfig::isInit() const
{
    return _bInit;
}


} // end of namespace math
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKMATH_ESTIMATIONCONFIG_H__