HistogramUtils.h

Go to the documentation of this file.

// HistogramUtils.h:
// -----------------
//

#ifndef __IPSDKMATH_HISTOGRAMUTILS_H__
#define __IPSDKMATH_HISTOGRAMUTILS_H__

#include <IPSDKMath/IPSDKMathExports.h>
#include <IPSDKUtil/BaseTypes.h>
#include <IPSDKMath/Statistics/HistogramTypes.h>
#include <IPSDKSerialization/Engine/SerializationEnumHdrMacro.h>
#include <boost/filesystem/path.hpp>
#include <iostream>

namespace ipsdk {
namespace math {


IPSDKMATH_API ipReal64
computeHistogramRange(const ipBool bDataIntegral,
                      const ipReal64 firstHistoValue,
                      const ipReal64 lastHistoValue);

IPSDKMATH_API ipUInt32
computeHistogramNbClasses(const ipBool bDataIntegral,
                          const ipReal64 firstHistoValue,
                          const ipReal64 lastHistoValue,
                          const ipReal64 binWidth);

IPSDKMATH_API ipReal64
computeHistogramBinWidth(const ipBool bDataIntegral,
                         const ipReal64 firstHistoValue,
                         const ipReal64 lastHistoValue,
                         const ipUInt32 nbClasses);

IPSDKMATH_API void
computeHistogramBoundsInfo(const ipUInt32 nbClasses,
                           const eHistogramOutOfBoundsPolicy& outOfBoundsPolicy,
                           ipUInt32& lowerOutOfBoundsBinIdx,
                           ipUInt32& upperOutOfBoundsBinIdx,
                           ipUInt32& inBoundsBinOffset,
                           ipUInt32& nbBins);

IPSDKMATH_API ipUInt32
computeHistogramNbBins(const ipUInt32 nbClasses,
                       const eHistogramOutOfBoundsPolicy& outOfBoundsPolicy);

IPSDKMATH_API void
exportToCsv(const boost::filesystem::path& filePath,
            const ipsdk::math::BaseHistogram& histogram);

IPSDKMATH_API bool
operator== (const ipsdk::math::HistogramExtrema& extrema1,
            const ipsdk::math::HistogramExtrema& extrema2);

IPSDKMATH_API std::ostream&
operator<< (std::ostream& os,
            const ipsdk::math::HistogramExtrema& extrema);

IPSDKMATH_API std::ostream&
operator<< (std::ostream& os,
            const ipsdk::math::HistogramGaussianCurveFit& gaussianCurveFit);

IPSDKMATH_API std::ostream&
operator<< (std::ostream& os,
            const ipsdk::math::BaseHistogram& histogram);


} // end of namespace math


IPSDK_DECLARE_SERIAL_ENUM(IPSDKMath, ipsdk::math::eHistogramOutOfBoundsPolicy);


} // end of namespace ipsdk

#endif // __IPSDKMATH_HISTOGRAMUTILS_H__