Visual Servoing Platform  version 3.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
vpHistogramPeak.h
1 /****************************************************************************
2  *
3  * This file is part of the ViSP software.
4  * Copyright (C) 2005 - 2017 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * ("GPL") version 2 as published by the Free Software Foundation.
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 http://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  * Author:
34  * Fabien Spindler
35  *
36  *****************************************************************************/
37 
38 
39 
47 #ifndef vpHistogramPeak_h
48 #define vpHistogramPeak_h
49 
50 #include <visp3/core/vpConfig.h>
51 
52 #include <ostream>
53 
66 class VISP_EXPORT vpHistogramPeak
67 {
68 public :
70  vpHistogramPeak(unsigned char level, unsigned value);
72 
74  virtual ~vpHistogramPeak() {}
75 
76  vpHistogramPeak & operator=(const vpHistogramPeak &p);
77  bool operator==(const vpHistogramPeak &p) const;
78 
89  inline void setLevel(unsigned char lvl)
90  {
91  this->level = lvl;
92  };
103  inline void setValue(unsigned val)
104  {
105  this->value = val;
106  };
117  inline void set(unsigned char lvl, unsigned val)
118  {
119  this->level = lvl;
120  this->value = val;
121  };
122 
133  inline unsigned char getLevel() const
134  {
135  return level;
136  };
147  inline unsigned getValue() const
148  {
149  return value;
150  };
151 
152  //---------------------------------
153  // Printing
154  //---------------------------------
155  friend VISP_EXPORT std::ostream &operator << (std::ostream &s, const vpHistogramPeak &p);
156 
157 
158 protected :
159  unsigned char level;
160  unsigned value;
161 };
162 
163 
164 /*
165  * Local variables:
166  * c-basic-offset: 2
167  * End:
168  */
169 
170 #endif
unsigned getValue() const
Declaration of the peak (maximum value) in a gray level image histogram.
void setLevel(unsigned char lvl)
void set(unsigned char lvl, unsigned val)
unsigned char level
unsigned value
Gray level ot the peak.
virtual ~vpHistogramPeak()
unsigned char getLevel() const
void setValue(unsigned val)