Visual Servoing Platform  version 3.2.0 under development (2018-10-19)
vpHistogramPeak Class Reference

#include <visp3/core/vpHistogramPeak.h>

+ Inheritance diagram for vpHistogramPeak:

Public Member Functions

 vpHistogramPeak ()
 
 vpHistogramPeak (unsigned char level, unsigned value)
 
 vpHistogramPeak (const vpHistogramPeak &p)
 
virtual ~vpHistogramPeak ()
 
vpHistogramPeakoperator= (const vpHistogramPeak &p)
 
bool operator== (const vpHistogramPeak &p) const
 
void setLevel (unsigned char lvl)
 
void setValue (unsigned val)
 
void set (unsigned char lvl, unsigned val)
 
unsigned char getLevel () const
 
unsigned getValue () const
 

Protected Attributes

unsigned char level
 
unsigned value
 

Friends

VISP_EXPORT std::ostream & operator<< (std::ostream &s, const vpHistogramPeak &p)
 

Detailed Description

Declaration of the peak (maximum value) in a gray level image histogram.

A peak is internally represented as a gray level and a value. The value represents the number of pixels having the gray level.

Examples:
histogram.cpp.

Definition at line 65 of file vpHistogramPeak.h.

Constructor & Destructor Documentation

vpHistogramPeak::vpHistogramPeak ( )

Defaut constructor for a gray level histogram peak.

Definition at line 51 of file vpHistogramPeak.cpp.

vpHistogramPeak::vpHistogramPeak ( unsigned char  lvl,
unsigned  val 
)

Defaut constructor for a gray level histogram peak.

Definition at line 56 of file vpHistogramPeak.cpp.

vpHistogramPeak::vpHistogramPeak ( const vpHistogramPeak p)

Copy constructor of a gray level histogram peak.

Definition at line 61 of file vpHistogramPeak.cpp.

virtual vpHistogramPeak::~vpHistogramPeak ( )
inlinevirtual

Destructor that does nothing.

Definition at line 73 of file vpHistogramPeak.h.

Member Function Documentation

unsigned char vpHistogramPeak::getLevel ( ) const
inline

Get the peak gray level. The number of pixels having this gray level is available throw getValue().

Returns
Location of the peak or gray level.
See also
getValue()
Examples:
histogram.cpp.

Definition at line 126 of file vpHistogramPeak.h.

Referenced by vpHistogram::getPeaks(), and vpHistogram::getValey().

unsigned vpHistogramPeak::getValue ( ) const
inline

Get the peak number of pixels having a same gray level. The corresponding gray level is available throw getLevel().

Returns
: Number of pixels having the same location or gray level.
See also
getLevel()
Examples:
histogram.cpp.

Definition at line 137 of file vpHistogramPeak.h.

Referenced by vpHistogram::getPeaks(), and vpHistogram::getValey().

vpHistogramPeak & vpHistogramPeak::operator= ( const vpHistogramPeak p)

Copy operator.

Parameters
p: Histogram peak to copy.
vpHistogramPeak p1(0, 255);
vpHistogramPeak p2 = p1; // Peak p2 is set to 0, 255

Definition at line 73 of file vpHistogramPeak.cpp.

References level, setLevel(), setValue(), and value.

Referenced by vpHistogramValey::~vpHistogramValey().

bool vpHistogramPeak::operator== ( const vpHistogramPeak p) const

Comparison operator.

Parameters
p: Gray level histogram peak to compar.

Definition at line 88 of file vpHistogramPeak.cpp.

References level, and value.

Referenced by vpHistogramValey::~vpHistogramValey().

void vpHistogramPeak::set ( unsigned char  lvl,
unsigned  val 
)
inline

Set the peak gray level and number of pixels at this gray level.

Parameters
lvl: Location of the peak or gray level.
val: Number of pixels having the same location or gray level.
See also
setLevel(), setValue()

Definition at line 110 of file vpHistogramPeak.h.

Referenced by vpHistogram::getPeaks(), and vpHistogram::getValey().

void vpHistogramPeak::setLevel ( unsigned char  lvl)
inline

Set the peak gray level. To set the number of pixels having this gray level use setValue().

Parameters
lvl: Location of the peak or gray level.
See also
setValue(), set()

Definition at line 88 of file vpHistogramPeak.h.

Referenced by operator=().

void vpHistogramPeak::setValue ( unsigned  val)
inline

Set the peak number of pixels having a same gray level. To set the gray level of this peak use setLevel().

Parameters
val: Number of pixels having the same location or gray level.
See also
setLevel(), set()

Definition at line 99 of file vpHistogramPeak.h.

Referenced by operator=().

Friends And Related Function Documentation

VISP_EXPORT std::ostream & operator<< ( std::ostream &  s,
const vpHistogramPeak p 
)
friend

std::cout a peak

Definition at line 94 of file vpHistogramPeak.cpp.

Referenced by vpHistogramValey::getValue().

Member Data Documentation

unsigned char vpHistogramPeak::level
protected
unsigned vpHistogramPeak::value
protected