Visual Servoing Platform  version 3.6.1 under development (2024-04-24)
vpHistogramPeak.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2023 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See https://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * Gray level histogram manipulation.
32  */
33 
40 #ifndef vpHistogramPeak_h
41 #define vpHistogramPeak_h
42 
43 #include <visp3/core/vpConfig.h>
44 
45 #include <ostream>
46 
59 class VISP_EXPORT vpHistogramPeak
60 {
61 public:
63  vpHistogramPeak(unsigned char level, unsigned value);
65 
67  virtual ~vpHistogramPeak() {}
68 
69  vpHistogramPeak &operator=(const vpHistogramPeak &p);
70  bool operator==(const vpHistogramPeak &p) const;
71 
82  inline void setLevel(unsigned char lvl) { this->level = lvl; };
93  inline void setValue(unsigned val) { this->value = val; };
104  inline void set(unsigned char lvl, unsigned val)
105  {
106  this->level = lvl;
107  this->value = val;
108  };
109 
120  inline unsigned char getLevel() const { return level; };
131  inline unsigned getValue() const { return value; };
132 
133  //---------------------------------
134  // Printing
135  //---------------------------------
136  friend VISP_EXPORT std::ostream &operator<<(std::ostream &s, const vpHistogramPeak &p);
137 
138 protected:
139  unsigned char level;
140  unsigned value;
141 };
142 
143 /*
144  * Local variables:
145  * c-basic-offset: 2
146  * End:
147  */
148 
149 #endif
Declaration of the peak (maximum value) in a gray level image histogram.
void set(unsigned char lvl, unsigned val)
void setLevel(unsigned char lvl)
virtual ~vpHistogramPeak()
unsigned value
Gray level ot the peak.
unsigned char level
void setValue(unsigned val)
unsigned getValue() const
unsigned char getLevel() const