Visual Servoing Platform  version 3.6.1 under development (2024-11-21)
vpHistogramPeak.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2024 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 VP_HISTOGRAM_PEAK_H
41 #define VP_HISTOGRAM_PEAK_H
42 
43 #include <visp3/core/vpConfig.h>
44 
45 #include <ostream>
46 
47 BEGIN_VISP_NAMESPACE
60 class VISP_EXPORT vpHistogramPeak
61 {
62 public:
64  vpHistogramPeak(unsigned char level, unsigned value);
66 
68  virtual ~vpHistogramPeak() { }
69 
70  vpHistogramPeak &operator=(const vpHistogramPeak &p);
71  bool operator==(const vpHistogramPeak &p) const;
72 
83  inline void setLevel(unsigned char lvl) { this->level = lvl; };
94  inline void setValue(unsigned val) { this->value = val; };
105  inline void set(unsigned char lvl, unsigned val)
106  {
107  this->level = lvl;
108  this->value = val;
109  };
110 
121  inline unsigned char getLevel() const { return level; };
132  inline unsigned getValue() const { return value; };
133 
134  //---------------------------------
135  // Printing
136  //---------------------------------
137  friend VISP_EXPORT std::ostream &operator<<(std::ostream &s, const vpHistogramPeak &p);
138 
139 protected:
140  unsigned char level;
141  unsigned value;
142 };
143 
144 /*
145  * Local variables:
146  * c-basic-offset: 2
147  * End:
148  */
149 END_VISP_NAMESPACE
150 #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