Visual Servoing Platform  version 3.0.0
vpHistogramValey.h
1 /****************************************************************************
2  *
3  * This file is part of the ViSP software.
4  * Copyright (C) 2005 - 2015 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 vpHistogramValey_h
48 #define vpHistogramValey_h
49 
50 #include <visp3/core/vpHistogramPeak.h>
51 
64 class VISP_EXPORT vpHistogramValey : vpHistogramPeak
65 {
66  public:
68  vpHistogramPeak() {};
69 
70  vpHistogramValey(unsigned char lvl, unsigned val) :
71  vpHistogramPeak(lvl, val) {};
72 
74  vpHistogramPeak(v) {};
75 
77  virtual ~vpHistogramValey() {}
78 
80  bool operator==(const vpHistogramValey &v) const;
81 
92  inline void setLevel(unsigned char lvl)
93  {
94  this->level = lvl;
95  };
106  inline void setValue(unsigned val)
107  {
108  this->value = val;
109  };
120  inline void set(unsigned char lvl, unsigned val)
121  {
122  this->level = lvl;
123  this->value = val;
124  };
125 
136  inline unsigned char getLevel() const
137  {
138  return level;
139  };
150  inline unsigned getValue() const
151  {
152  return value;
153  };
154 
155  //---------------------------------
156  // Printing
157  //---------------------------------
158  friend VISP_EXPORT std::ostream &operator << (std::ostream &s, const vpHistogramValey &v);
159 };
160 
161 /*
162  * Local variables:
163  * c-basic-offset: 2
164  * End:
165  */
166 
167 #endif
void setValue(unsigned val)
vpHistogramValey(unsigned char lvl, unsigned val)
virtual ~vpHistogramValey()
Declaration of the peak (maximum value) in a gray level image histogram.
vpHistogramPeak & operator=(const vpHistogramPeak &p)
unsigned char getLevel() const
unsigned getValue() const
unsigned char level
void set(unsigned char lvl, unsigned val)
vpHistogramValey(const vpHistogramValey &v)
unsigned value
Gray level ot the peak.
friend VISP_EXPORT std::ostream & operator<<(std::ostream &s, const vpHistogramPeak &p)
std::cout a peak
Declaration of the valey (minimum value) in a gray level image histogram.
bool operator==(const vpHistogramPeak &p) const
void setLevel(unsigned char lvl)