HistogramData.h

// HistogramData.h:
// ----------------
//

#ifndef __IPSDKIPLATTRIBUTES_HISTOGRAMDATA_H__
#define __IPSDKIPLATTRIBUTES_HISTOGRAMDATA_H__

#include <IPSDKIPL/IPSDKIPLAttributes/IPSDKIPLAttributesExports.h>
#include <IPSDKBaseData/DataItem/Node/DataItemNodeHdrMacros.h>
#include <IPSDKUtil/BaseCollections.h>
#include <IPSDKMath/Statistics/HistogramTypes.h>

namespace ipsdk {
namespace imaproc {
namespace attr {


IPSDK_DECLARE_NODE_DATA(IPSDKIPLAttributes, HistogramData,
                        ((LEAF)(Min)(ipsdk::ipReal64))
                        ((LEAF)(Max)(ipsdk::ipReal64))
                        ((LEAF)(BinWidth)(ipsdk::ipReal64))
                        ((LEAF_COLL)(Frequencies)(ipsdk::ipUInt64)))

public:
    ipsdk::ipReal64     getRange() const;

    ipsdk::ipReal64     getBinMin(const ipUInt32 nBinIdx) const;

    ipsdk::ipReal64     getBinMax(const ipUInt32 nBinIdx) const;

    ipsdk::ipReal64     getBinMean(const ipUInt32 nBinIdx) const;

    ipsdk::ipReal64     getBinRange(const ipUInt32 nBinIdx) const;

    ipsdk::ipUInt32     getNbClasses() const;

    ipsdk::Real64Vector getBinMinColl() const;

    ipsdk::Real64Vector getBinMaxColl() const;

    ipsdk::Real64Vector getBinMeanColl() const;

    ipsdk::Real64Vector getBinRangeColl() const;

    ipsdk::ipUInt64     getPopulation() const;

    operator ipsdk::math::HistogramPtr() const;
};


typedef boost::shared_ptr<ipsdk::imaproc::attr::HistogramData> HistogramDataPtr;

typedef boost::shared_ptr<const ipsdk::imaproc::attr::HistogramData> HistogramDataConstPtr;
            

IPSDKIPLATTRIBUTES_API void
exportToCsv(const boost::filesystem::path& filePath,
            const ipsdk::imaproc::attr::HistogramData& histogramData);


} // end of namespace attr
} // end of namespace imaproc
} // end of namespace ipsdk

#endif // __IPSDKIPLATTRIBUTES_HISTOGRAMDATA_H__