BaseRobustEstimator.h

// BaseRobustEstimator.h:
// ----------------------
//

#ifndef __IPSDKMATH_BASEROBUSTESTIMATOR_H__
#define __IPSDKMATH_BASEROBUSTESTIMATOR_H__

// suppression warnings
// warning C4251: 'ipsdk::math::BaseRobustEstimator::_pDataPartition': class 'boost::shared_ptr<ipsdk::math::BaseDataPartition>' needs to have dll-interface to be used by clients of class 'ipsdk::math::BaseRobustEstimator'
// warning C4275: interface non dll class 'boost::noncopyable_::noncopyable' utilisée comme base d'une interface dll class 'ipsdk::math::BaseRobustEstimator'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKMath/IPSDKMathExports.h>
#include <IPSDKMath/Estimation/EstimationTypes.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <boost/noncopyable.hpp>

namespace ipsdk {
namespace math {


class IPSDKMATH_API BaseRobustEstimator : public boost::noncopyable
{
public:
    BaseRobustEstimator();
    virtual ~BaseRobustEstimator() = 0;

// methods
public:
    bool                        isInit() const;

    virtual ipReal64            getMaxOutlierRatio() const;

    ipReal64                    getExpectedOutlierRatio() const;

    void                        setExpectedOutlierRatio(const ipReal64 expectedOutlierRatio);

    void                        setSuccessRatio(const ipReal64 successRatio);

    ipReal64                    getSuccessRatio() const;

    void                        setDataPartition(const DataPartitionPtr& pDataPartition);

    const BaseDataPartition&    getDataPartition() const;

    const BaseEstimator&        getEstimator() const;

    ipUInt32                    getNbMinDataForRobustEstimation() const;

    ipUInt32                    getNbNeededRuns() const;

    bool                        isEstimationDone() const;

    // \return false in case of failure
    BoolResult                  computeEstimation(const DataSet& dataSet);

    const ParameterType&        getEstimParams() const;

    const OutlierFlags&         getOutlierFlags() const;

    ipReal64                    getEstimOutlierThreshold() const;

    void                        clearEstimation();

protected:
    void                    initBase(const EstimatorPtr& pEstimator);

    virtual ipReal64        computeOutlierThreshold(const ipReal64 bestScore,
                                                    const ipUInt32 nbData,
                                                    const ipUInt32 nbMinRequestedData) const = 0;

    virtual ipReal64        computeScore(const ResidualsSet& curResiduals) = 0;

    virtual void            clearDerived() {};

private:
    void                    updateNbNeededRun();

// attributes
protected:
    ipReal64            _expectedOutlierRatio;

    ipReal64            _successRatio;

    DataPartitionPtr    _pDataPartition;

    ipUInt32            _nbNeededRuns;

    EstimatorPtr        _pEstimator;

    ParameterType       _estimParams;

    OutlierFlags        _outlierFlags;

    ipReal64            _estimOutlierThreshold;
};


inline ipReal64
BaseRobustEstimator::getExpectedOutlierRatio() const
{
    return _expectedOutlierRatio;
}

inline ipReal64
BaseRobustEstimator::getSuccessRatio() const
{
    return _successRatio;
}

inline bool
BaseRobustEstimator::isInit() const
{
    return _pEstimator.get() != 0;
}

inline const BaseDataPartition&
BaseRobustEstimator::getDataPartition() const
{
    return *_pDataPartition;
}


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

#pragma warning(pop)

#endif // __IPSDKMATH_BASEROBUSTESTIMATOR_H__