Visual Servoing Platform  version 3.6.1 under development (2024-12-03)
vpHistogramValey.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 
41 #ifndef VP_HISTOGRAM_VALEY_H
42 #define VP_HISTOGRAM_VALEY_H
43 
44 #include <visp3/core/vpHistogramPeak.h>
45 
46 BEGIN_VISP_NAMESPACE
59 class VISP_EXPORT vpHistogramValey : vpHistogramPeak
60 {
61 public:
63 
64  vpHistogramValey(unsigned char lvl, unsigned val) : vpHistogramPeak(lvl, val) { };
65 
67 
69  bool operator==(const vpHistogramValey &v) const;
70 
81  inline void setLevel(unsigned char lvl) { this->level = lvl; };
92  inline void setValue(unsigned val) { this->value = val; };
103  inline void set(unsigned char lvl, unsigned val)
104  {
105  this->level = lvl;
106  this->value = val;
107  };
108 
119  inline unsigned char getLevel() const { return level; };
130  inline unsigned getValue() const { return value; };
131 
132  //---------------------------------
133  // Printing
134  //---------------------------------
135  friend VISP_EXPORT std::ostream &operator<<(std::ostream &s, const vpHistogramValey &v);
136 };
137 
138 /*
139  * Local variables:
140  * c-basic-offset: 2
141  * End:
142  */
143 END_VISP_NAMESPACE
144 #endif
Declaration of the peak (maximum value) in a gray level image histogram.
friend VISP_EXPORT std::ostream & operator<<(std::ostream &s, const vpHistogramPeak &p)
std::cout a peak
bool operator==(const vpHistogramPeak &p) const
unsigned value
Gray level ot the peak.
unsigned char level
vpHistogramPeak & operator=(const vpHistogramPeak &p)
Declaration of the valey (minimum value) in a gray level image histogram.
vpHistogramValey(const vpHistogramValey &v)
void setLevel(unsigned char lvl)
vpHistogramValey(unsigned char lvl, unsigned val)
unsigned char getLevel() const
unsigned getValue() const
void set(unsigned char lvl, unsigned val)
void setValue(unsigned val)