Visual Servoing Platform  version 3.2.0 under development (2018-12-13)
vpHistogramValey Class Reference

#include <visp3/core/vpHistogramValey.h>

+ Inheritance diagram for vpHistogramValey:

Public Member Functions

 vpHistogramValey ()
 
 vpHistogramValey (unsigned char lvl, unsigned val)
 
 vpHistogramValey (const vpHistogramValey &v)
 
virtual ~vpHistogramValey ()
 
vpHistogramValeyoperator= (const vpHistogramValey &v)
 
bool operator== (const vpHistogramValey &v) const
 
void setLevel (unsigned char lvl)
 
void setValue (unsigned val)
 
void set (unsigned char lvl, unsigned val)
 
unsigned char getLevel () const
 
unsigned getValue () const
 

Private Member Functions

bool operator== (const vpHistogramPeak &p) const
 

Private Attributes

unsigned char level
 
unsigned value
 

Friends

VISP_EXPORT std::ostream & operator<< (std::ostream &s, const vpHistogramValey &v)
 

Detailed Description

Declaration of the valey (minimum value) in a gray level image histogram.

A valey 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 63 of file vpHistogramValey.h.

Constructor & Destructor Documentation

vpHistogramValey::vpHistogramValey ( )
inline

Definition at line 66 of file vpHistogramValey.h.

vpHistogramValey::vpHistogramValey ( unsigned char  lvl,
unsigned  val 
)
inline

Definition at line 68 of file vpHistogramValey.h.

vpHistogramValey::vpHistogramValey ( const vpHistogramValey v)
inline

Definition at line 70 of file vpHistogramValey.h.

virtual vpHistogramValey::~vpHistogramValey ( )
inlinevirtual

Destructor that does nothing.

Definition at line 73 of file vpHistogramValey.h.

References vpHistogramPeak::operator=(), and vpHistogramPeak::operator==().

Member Function Documentation

unsigned char vpHistogramValey::getLevel ( ) const
inline

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

Returns
Location of the valey or gray level.
See also
getValue()

Definition at line 126 of file vpHistogramValey.h.

References vpHistogramPeak::level.

unsigned vpHistogramValey::getValue ( ) const
inline

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

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

Definition at line 137 of file vpHistogramValey.h.

References vpHistogramPeak::operator<<, and vpHistogramPeak::value.

vpHistogramValey & vpHistogramValey::operator= ( const vpHistogramValey v)

Copy operator.

Parameters
v: Histogram valey to copy.
vpHistogramValey v1(0, 255);
vpHistogramValey v2 = v1; // Valey p2 is set to 0, 255

Definition at line 58 of file vpHistogramValey.cpp.

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

bool vpHistogramValey::operator== ( const vpHistogramValey v) const

Comparison operator.

Parameters
v: Gray level histogram valey to compar.

Definition at line 73 of file vpHistogramValey.cpp.

References vpHistogramPeak::level, and vpHistogramPeak::value.

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

Set the valey gray level and number of pixels at this location.

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

Definition at line 110 of file vpHistogramValey.h.

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

void vpHistogramValey::setLevel ( unsigned char  lvl)
inline

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

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

Definition at line 88 of file vpHistogramValey.h.

Referenced by operator=().

void vpHistogramValey::setValue ( unsigned  val)
inline

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

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

Definition at line 99 of file vpHistogramValey.h.

Referenced by operator=().

Friends And Related Function Documentation

VISP_EXPORT std::ostream & operator<< ( std::ostream &  s,
const vpHistogramValey v 
)
friend

std::cout a valey

Definition at line 82 of file vpHistogramValey.cpp.