Visual Servoing Platform  version 3.4.1 under development (2021-04-20)
vpHistogramPeak.h
1 /****************************************************************************
2  *
3  * ViSP, open source Visual Servoing Platform software.
4  * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * See the file LICENSE.txt at the root directory of this source
11  * distribution for additional information about the GNU GPL.
12  *
13  * For using ViSP with software that can not be combined with the GNU
14  * GPL, please contact Inria about acquiring a ViSP Professional
15  * Edition License.
16  *
17  * See http://visp.inria.fr for more information.
18  *
19  * This software was developed at:
20  * Inria Rennes - Bretagne Atlantique
21  * Campus Universitaire de Beaulieu
22  * 35042 Rennes Cedex
23  * France
24  *
25  * If you have questions regarding the use of this file, please contact
26  * Inria at visp@inria.fr
27  *
28  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30  *
31  * Description:
32  * Gray level histogram manipulation.
33  *
34  * Author:
35  * Fabien Spindler
36  *
37  *****************************************************************************/
38 
46 #ifndef vpHistogramPeak_h
47 #define vpHistogramPeak_h
48 
49 #include <visp3/core/vpConfig.h>
50 
51 #include <ostream>
52 
65 class VISP_EXPORT vpHistogramPeak
66 {
67 public:
69  vpHistogramPeak(unsigned char level, unsigned value);
71 
73  virtual ~vpHistogramPeak() {}
74 
75  vpHistogramPeak &operator=(const vpHistogramPeak &p);
76  bool operator==(const vpHistogramPeak &p) const;
77 
88  inline void setLevel(unsigned char lvl) { this->level = lvl; };
99  inline void setValue(unsigned val) { this->value = val; };
110  inline void set(unsigned char lvl, unsigned val)
111  {
112  this->level = lvl;
113  this->value = val;
114  };
115 
126  inline unsigned char getLevel() const { return level; };
137  inline unsigned getValue() const { return value; };
138 
139  //---------------------------------
140  // Printing
141  //---------------------------------
142  friend VISP_EXPORT std::ostream &operator<<(std::ostream &s, const vpHistogramPeak &p);
143 
144 protected:
145  unsigned char level;
146  unsigned value;
147 };
148 
149 /*
150  * Local variables:
151  * c-basic-offset: 2
152  * End:
153  */
154 
155 #endif
Declaration of the peak (maximum value) in a gray level image histogram.
void setLevel(unsigned char lvl)
unsigned char getLevel() const
unsigned char level
unsigned value
Gray level ot the peak.
virtual ~vpHistogramPeak()
unsigned getValue() const
void setValue(unsigned val)