vpHistogram.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Gray level histogram manipulation.
 */
 
#ifndef VP_HISTOGRAM_H
#define VP_HISTOGRAM_H
 
#include <sstream>
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpColor.h>
#include <visp3/core/vpHistogramPeak.h>
#include <visp3/core/vpHistogramValey.h>
#include <visp3/core/vpImage.h>
 
#include <list>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpHistogram
{
public:
  vpHistogram();
  vpHistogram(const vpHistogram &h);
  VP_EXPLICIT vpHistogram(const vpImage<unsigned char> &I);
  VP_EXPLICIT vpHistogram(const vpImage<unsigned char> &I, const vpImage<bool> *p_mask);
  virtual ~vpHistogram();
 
  vpHistogram &operator=(const vpHistogram &h);
 
  inline unsigned operator[](const unsigned char level) const
  {
    if (level < m_size) {
      return m_histogram[level];
    }
 
    std::stringstream ss;
    ss << "Level is > to size (" << m_size << ") !";
    throw vpException(vpException::dimensionError, ss.str().c_str());
  };
  inline unsigned operator()(const unsigned char level) const
  {
    if (level < m_size) {
      return m_histogram[level];
    }
 
    std::stringstream ss;
    ss << "Level is > to size (" << m_size << ") !";
    throw vpException(vpException::dimensionError, ss.str().c_str());
  };
  inline unsigned get(const unsigned char level) const
  {
    if (level < m_size) {
      return m_histogram[level];
    }
 
    std::stringstream ss;
    ss << "Level is > to size (" << m_size << ") !";
    throw vpException(vpException::dimensionError, ss.str().c_str());
  };
 
  inline void set(const unsigned char level, unsigned int value)
  {
    if (level < m_size) {
      m_histogram[level] = value;
    }
    else {
      std::stringstream ss;
      ss << "Level is > to size (" << m_size << ") !";
      throw vpException(vpException::dimensionError, ss.str().c_str());
    }
  };
 
  inline void setMask(const vpImage<bool> *p_mask)
  {
    mp_mask = p_mask;
  }
 
  void calculate(const vpImage<unsigned char> &I, unsigned int nbins = 256, unsigned int nbThreads = 1);
  void equalize(const vpImage<unsigned char> &I, vpImage<unsigned char> &Iout);
 
  void display(const vpImage<unsigned char> &I, const vpColor &color = vpColor::white, unsigned int thickness = 2,
               unsigned int maxValue_ = 0);
 
  void smooth(unsigned int fsize = 3);
  unsigned getPeaks(std::list<vpHistogramPeak> &peaks);
  unsigned getPeaks(unsigned char dist, vpHistogramPeak &peak1, vpHistogramPeak &peak2);
  bool getPeaks(unsigned char dist, vpHistogramPeak &peakl, vpHistogramPeak &peakr, vpHistogramValey &valey);
  unsigned getValey(std::list<vpHistogramValey> &valey);
  bool getValey(const vpHistogramPeak &peak1, const vpHistogramPeak &peak2, vpHistogramValey &valey);
  unsigned getValey(unsigned char dist, const vpHistogramPeak &peak, vpHistogramValey &valeyl,
                    vpHistogramValey &valeyr);
  unsigned sort(std::list<vpHistogramPeak> &peaks);
 
  bool write(const std::string &filename);
  bool write(const char *filename);
 
  inline unsigned getSize() const { return m_size; };
 
  inline unsigned *getValues() { return m_histogram; };
 
  inline unsigned int getTotal() { return m_total; };
 
private:
  void init(unsigned size = 256);
 
  unsigned int *m_histogram; 
  unsigned m_size; 
  const vpImage<bool> *mp_mask; 
  unsigned int m_total; 
};
END_VISP_NAMESPACE
#endif