EstimationResults.h

// EstimationResults.h:
// --------------------
//

#ifndef __IPSDKMATH_ESTIMATIONRESULTS_H__
#define __IPSDKMATH_ESTIMATIONRESULTS_H__

// suppression warnings
// warning C4251: 'ipsdk::math::EstimationResults::_estimationStatus': class 'ipsdk::ProcessingResult<bool>' needs to have dll-interface to be used by clients of class 'ipsdk::math::EstimationResults'
#pragma warning (push)
#pragma warning (disable : 4251)

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

namespace ipsdk {
namespace math {


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

public:
    EstimationResults();
    ~EstimationResults();

// methods
public:
    bool                        isInit() const;

    void                        initFailed(const EstimationConfig& config,
                                           const ipUInt32 nbEstimParams,
                                           const ipUInt32 inputDataSize,
                                           const ipUInt32 nbMinDataForEstimation,
                                           const ipUInt32 nbMinDataForRobustEstimation,
                                           const ipUInt32 nbInputData,
                                           const std::string& failureMessage);

    void                        initRobustSuccess(const EstimationConfig& config,
                                                  const ipUInt32 nbEstimParams,
                                                  const ipUInt32 inputDataSize,
                                                  const ipUInt32 nbMinDataForEstimation,
                                                  const ipUInt32 nbMinDataForRobustEstimation,
                                                  const ipUInt32 nbInputData,
                                                  const ParameterType& estimParams,
                                                  const ResidualsSet& residualsSet,
                                                  const OutlierFlags& outlierFlags,
                                                  const ipReal64 estimOutlierThreshold);

    void                        initSimpleSuccess(const EstimationConfig& config,
                                                  const ipUInt32 nbEstimParams,
                                                  const ipUInt32 inputDataSize,
                                                  const ipUInt32 nbMinDataForEstimation,
                                                  const ipUInt32 nbMinDataForRobustEstimation,
                                                  const ipUInt32 nbInputData,
                                                  const ParameterType& estimParams,
                                                  const ResidualsSet& residualsSet);

    const EstimationConfig&     getEstimationConfig() const;

    ipUInt32                    getNbEstimParams() const;

    ipUInt32                    getInputDataSize() const;

    ipUInt32                    getNbMinDataForEstimation() const;

    ipUInt32                    getNbMinDataForRobustEstimation() const;

    ipUInt32                    getNbInputData() const;

    const BoolResult&           getEstimationStatus() const;

    bool                        hasRobustEstimationDone() const;

    const ParameterType&        getEstimParams() const;

    const ResidualsSet&         getResidualsSet() const;

    const OutlierFlags&         getOutlierFlags() const;

    ipReal64                    getEstimOutlierThreshold() const;

    ipReal64                    getGlobalRms() const;

    ipReal64                    getInliersRms() const;

    ipUInt32                    getNbOutliers() const;

    ipUInt32                    getNbInliers() const;

    ipReal64                    getOutlierRatio() const;

    ipReal64                    getInlierRatio() const;

    void                        updateNonLinearFailed(const std::string& failureMessage);
    void                        updateNonLinearSuccess(const ParameterType& estimParams,
                                                       const ResidualsSet& residualsSet,
                                                       const ipUInt32 nbNonLinearIteration,
                                                       const std::string& warnMessage = "");

    ipUInt32                    getNbNonLinearIteration() const;

    void                        clear();

// attributes
protected:
    bool                    _bInit;

    EstimationConfig        _config;

    ipUInt32                _nbEstimParams;

    ipUInt32                _inputDataSize;

    ipUInt32                _nbMinDataForEstimation;

    ipUInt32                _nbMinDataForRobustEstimation;

    ipUInt32                _nbInputData;

    BoolResult              _estimationStatus;

    bool                    _bRobustEstimationDone;

    ParameterType           _estimParams;

    ResidualsSet            _residualsSet;

    OutlierFlags            _outlierFlags;

    ipReal64                _estimOutlierThreshold;

    ipUInt32                _nbNonLinearIteration;
};


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


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

#pragma warning (pop)

#endif // __IPSDKMATH_ESTIMATIONRESULTS_H__