drwnColourHistogram.h

/*****************************************************************************
** DARWIN: A FRAMEWORK FOR MACHINE LEARNING RESEARCH AND DEVELOPMENT
** Distributed under the terms of the BSD license (see the LICENSE file)
** Copyright (c) 2007-2015, Stephen Gould
** All rights reserved.
**
******************************************************************************
** FILENAME:    drwnColourHistogram.h
** AUTHOR(S):   Stephen Gould <stephen.gould@anu.edu.au>
**
*****************************************************************************/

#pragma once

#include <vector>

#include "cv.h"

// drwnColourHistogram ------------------------------------------------------


class drwnColourHistogram : public drwnStdObjIface {
 protected:
    unsigned _channelBits;        
    unsigned char _mask;          
    double _pseudoCounts;         
    vector<double> _histogram;    
    double _totalCounts;          

 public:
    drwnColourHistogram(double pseudoCounts = 1.0, unsigned channelBits = 3);
    drwnColourHistogram(const drwnColourHistogram& histogram);
    ~drwnColourHistogram() { /* do nothing */ }

    size_t size() const { return _histogram.size(); }

    void clear() { clear(_pseudoCounts); }
    void clear(double pseudoCounts);

    // i/o
    const char *type() const { return "drwnColourHistogram"; }
    drwnColourHistogram *clone() const { return new drwnColourHistogram(*this); }
    bool save(drwnXMLNode& xml) const;
    bool load(drwnXMLNode& xml);

    void accumulate(unsigned char red, unsigned char green, unsigned char blue);
    void accumulate(const cv::Vec3b& colour) {
        accumulate(colour.val[2], colour.val[1], colour.val[0]);
    }
    void accumulate(const cv::Scalar& colour) {
        accumulate(colour.val[2], colour.val[1], colour.val[0]);
    }

    double probability(unsigned char red, unsigned char green, unsigned char blue) const;
    double probability(const cv::Vec3b& colour) const {
        return probability(colour.val[2], colour.val[1], colour.val[0]);
    }
    double probability(const cv::Scalar& colour) const { 
        return probability(colour.val[2], colour.val[1], colour.val[0]); 
    }

    cv::Mat visualize() const;

    // operators
    const double& operator[](size_t indx) const { return _histogram[indx]; } 
};