Visual Servoing Platform  version 3.4.0
vpHistogramValey.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 vpHistogramValey_h
47 #define vpHistogramValey_h
48 
49 #include <visp3/core/vpHistogramPeak.h>
50 
63 class VISP_EXPORT vpHistogramValey : vpHistogramPeak
64 {
65 public:
67 
68  vpHistogramValey(unsigned char lvl, unsigned val) : vpHistogramPeak(lvl, val){};
69 
71 
73  virtual ~vpHistogramValey() {}
74 
76  bool operator==(const vpHistogramValey &v) 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 vpHistogramValey &v);
143 };
144 
145 /*
146  * Local variables:
147  * c-basic-offset: 2
148  * End:
149  */
150 
151 #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
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)