Visual Servoing Platform
version 3.6.1 under development (2024-11-11)
|
#include <visp3/core/vpHistogram.h>
Public Member Functions | |
vpHistogram () | |
vpHistogram (const vpHistogram &h) | |
VP_EXPLICIT | vpHistogram (const vpImage< unsigned char > &I) |
VP_EXPLICIT | vpHistogram (const vpImage< unsigned char > &I, const vpImage< bool > *p_mask) |
virtual | ~vpHistogram () |
vpHistogram & | operator= (const vpHistogram &h) |
unsigned | operator[] (const unsigned char level) const |
unsigned | operator() (const unsigned char level) const |
unsigned | get (const unsigned char level) const |
void | set (const unsigned char level, unsigned int value) |
void | setMask (const vpImage< bool > *p_mask) |
void | calculate (const vpImage< unsigned char > &I, unsigned int nbins=256, unsigned int nbThreads=1) |
void | equalize (const vpImage< unsigned char > &I, vpImage< unsigned char > &Iout) |
void | display (const vpImage< unsigned char > &I, const vpColor &color=vpColor::white, unsigned int thickness=2, unsigned int maxValue_=0) |
void | smooth (unsigned int fsize=3) |
unsigned | getPeaks (std::list< vpHistogramPeak > &peaks) |
unsigned | getPeaks (unsigned char dist, vpHistogramPeak &peak1, vpHistogramPeak &peak2) |
bool | getPeaks (unsigned char dist, vpHistogramPeak &peakl, vpHistogramPeak &peakr, vpHistogramValey &valey) |
unsigned | getValey (std::list< vpHistogramValey > &valey) |
bool | getValey (const vpHistogramPeak &peak1, const vpHistogramPeak &peak2, vpHistogramValey &valey) |
unsigned | getValey (unsigned char dist, const vpHistogramPeak &peak, vpHistogramValey &valeyl, vpHistogramValey &valeyr) |
unsigned | sort (std::list< vpHistogramPeak > &peaks) |
bool | write (const std::string &filename) |
bool | write (const char *filename) |
unsigned | getSize () const |
unsigned * | getValues () |
unsigned int | getTotal () |
Class to compute a gray level image histogram.
Here are two examples showing how to use this class to determine the threshold which can be used to segment two objects.
The code below:
has the same behaviour than this one:
Definition at line 105 of file vpHistogram.h.
vpHistogram::vpHistogram | ( | ) |
Default constructor for a gray level histogram.
Definition at line 195 of file vpHistogram.cpp.
vpHistogram::vpHistogram | ( | const vpHistogram & | h | ) |
Copy constructor of a gray level histogram.
Definition at line 200 of file vpHistogram.cpp.
vpHistogram::vpHistogram | ( | const vpImage< unsigned char > & | I | ) |
Calculates the histogram from a gray level image.
I | : Gray level image. |
Definition at line 213 of file vpHistogram.cpp.
References calculate().
Calculates the histogram from a gray level image using a binary mask.
I | : Gray level image. |
p_mask | A pointer towards a binary mask where true indicates that the pixel should considered and false that it should be ignored. |
Definition at line 228 of file vpHistogram.cpp.
References calculate(), and setMask().
|
virtual |
Destructor.
Definition at line 238 of file vpHistogram.cpp.
void vpHistogram::calculate | ( | const vpImage< unsigned char > & | I, |
unsigned int | nbins = 256 , |
||
unsigned int | nbThreads = 1 |
||
) |
Calculate the histogram from a gray level image.
I | : Gray level image. |
nbins | : Number of bins to compute the histogram. |
nbThreads | : Number of threads to use for the computation. |
Definition at line 299 of file vpHistogram.cpp.
References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), vpImage< Type >::getSize(), and vpImage< Type >::getWidth().
Referenced by vpImageFilter::computeCannyThreshold(), equalize(), VISP_NAMESPACE_NAME::gammaCorrectionProbBasedMethod(), and vpHistogram().
void vpHistogram::display | ( | const vpImage< unsigned char > & | I, |
const vpColor & | color = vpColor::white , |
||
unsigned int | thickness = 2 , |
||
unsigned int | maxValue_ = 0 |
||
) |
Display the histogram distribution in an image, the minimal image size is 36x36 px.
I | : Image with the histogram distribution displayed. |
color | : Color used for the display. |
thickness | : Thickness of the line. |
maxValue_ | : Maximum value in the histogram, if 0 it will be computed from the current histogram. Useful to plot a 3 channels histogram for a RGB image for example to keep a coherent vertical scale between the channels. |
Definition at line 474 of file vpHistogram.cpp.
References vpDisplay::displayLine(), vpException::divideByZeroError, vpImage< Type >::getHeight(), and vpImage< Type >::getWidth().
Definition at line 417 of file vpHistogram.cpp.
References calculate(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpImage< Type >::performLut(), and vpMath::round().
Referenced by VISP_NAMESPACE_NAME::equalizeHistogram().
|
inline |
Return the number of pixels having the gray level.
level | : Gray level in the histogram. |
Definition at line 196 of file vpHistogram.h.
References vpException::dimensionError.
unsigned vpHistogram::getPeaks | ( | std::list< vpHistogramPeak > & | peaks | ) |
Build a list of all histogram peaks. This peak list is gray level sorted from 0 to 255. That mean that the first peak has a gray level less than the second one, etc.
To sort this list from highest peak value to the lowest one, you can use sort().
peaks | : List of peaks. |
Definition at line 568 of file vpHistogram.cpp.
References vpImageException::notInitializedError, and vpHistogramPeak::set().
Referenced by getPeaks(), and getValey().
unsigned vpHistogram::getPeaks | ( | unsigned char | dist, |
vpHistogramPeak & | peak1, | ||
vpHistogramPeak & | peak2 | ||
) |
Find the two highest peaks in the histogram. Usually, the first one correspond to the image background, the second one to the object.
dist | : Minimal distance between two significative histogram peaks. |
peak1 | : Highest peak in the histogram. |
peak2 | : Second highest peak in the histogram. |
Definition at line 637 of file vpHistogram.cpp.
References vpHistogramPeak::getLevel(), getPeaks(), vpHistogramPeak::set(), and sort().
bool vpHistogram::getPeaks | ( | unsigned char | dist, |
vpHistogramPeak & | peakl, | ||
vpHistogramPeak & | peakr, | ||
vpHistogramValey & | valey | ||
) |
Determine the two highest peaks in the histogram and compute a threshold to separate the two objects. Here we dont know which is the highest peak. It could be peakl or peakr.
dist | : Distance between two significative histogram maxima |
peakl | : Position of the left histogram peak. |
peakr | : Position of the right histogram peak. |
valey | : Valey between the two peaks peakl and peakr. |
Definition at line 690 of file vpHistogram.cpp.
References vpHistogramPeak::getLevel(), vpHistogramPeak::getValue(), vpHistogramPeak::set(), and vpHistogramValey::set().
|
inline |
Get the histogram size.
Definition at line 278 of file vpHistogram.h.
Referenced by VISP_NAMESPACE_NAME::computeThresholdHuang(), VISP_NAMESPACE_NAME::computeThresholdIntermodes(), VISP_NAMESPACE_NAME::computeThresholdIsoData(), VISP_NAMESPACE_NAME::computeThresholdMean(), VISP_NAMESPACE_NAME::computeThresholdOtsu(), and VISP_NAMESPACE_NAME::computeThresholdTriangle().
|
inline |
Get the total number of pixels in the input image.
Definition at line 308 of file vpHistogram.h.
Referenced by vpImageFilter::computeCannyThreshold(), and VISP_NAMESPACE_NAME::gammaCorrectionProbBasedMethod().
bool vpHistogram::getValey | ( | const vpHistogramPeak & | peak1, |
const vpHistogramPeak & | peak2, | ||
vpHistogramValey & | valey | ||
) |
Find the valey between two peaks. It starts at the lowest peak and works its way up to the highest peak. Along the way, it looks at each point in the histogram to find the location of the smallest histogram point which is the valey point.
peak1 | : A peak in the histogram. |
peak2 | : A other peak in the histogram. |
valey | : Low point of the valey between two peaks in a histogram. |
Definition at line 909 of file vpHistogram.cpp.
References vpHistogramPeak::getLevel(), vpHistogramPeak::getValue(), and vpHistogramValey::set().
unsigned vpHistogram::getValey | ( | std::list< vpHistogramValey > & | valey | ) |
Build a list of all histogram valey. This valey list is gray level sorted from 0 to 255. That mean that the first valey has a gray level less than the second one, etc.
valey | : List of valey. |
Definition at line 842 of file vpHistogram.cpp.
References vpImageException::notInitializedError, and vpHistogramValey::set().
unsigned vpHistogram::getValey | ( | unsigned char | dist, |
const vpHistogramPeak & | peak, | ||
vpHistogramValey & | valeyl, | ||
vpHistogramValey & | valeyr | ||
) |
Find the two valey around an histogram peak. It starts at the peak position and works its way down and up to find the left and right valey around the peak.
dist | : Minimal distance between two significative histogram peaks. |
peak | : A peak in the histogram. |
valeyl | : The valey on the left of the peak. |
valeyr | : The valey on the right of the peak. |
Definition at line 978 of file vpHistogram.cpp.
References vpHistogramPeak::getLevel(), getPeaks(), vpHistogramPeak::getValue(), vpHistogramPeak::set(), and vpHistogramValey::set().
|
inline |
Get the histogram values.
Definition at line 301 of file vpHistogram.h.
|
inline |
Return the number of pixels having the gray level.
level | : Gray level in the histogram. |
Definition at line 166 of file vpHistogram.h.
References vpException::dimensionError.
vpHistogram & vpHistogram::operator= | ( | const vpHistogram & | h | ) |
|
inline |
Return the number of pixels having the gray level.
level | : Gray level in the histogram. |
Definition at line 136 of file vpHistogram.h.
References vpException::dimensionError.
|
inline |
Set the number of pixels having the gray level.
level | : Gray level in the histogram. Level is in [0:255] |
value | : Number of pixels having the gray level. |
Definition at line 224 of file vpHistogram.h.
References vpException::dimensionError.
Referenced by VISP_NAMESPACE_NAME::computeThresholdTriangle().
|
inline |
Set a mask to ignore pixels for which the mask is false.
p_mask | If different of nullptr , a mask of booleans where true indicates that a pixel must be considered and false that the pixel should be ignored. |
Definition at line 246 of file vpHistogram.h.
Referenced by vpImageFilter::computeCannyThreshold(), VISP_NAMESPACE_NAME::equalizeHistogram(), VISP_NAMESPACE_NAME::gammaCorrectionProbBasedMethod(), and vpHistogram().
void vpHistogram::smooth | ( | unsigned int | fsize = 3 | ) |
Smoothes the histogram.
A simple average scheme is used where each value in the histogram is replaced by the average of itself and the neighbors.
[in] | fsize | : Filter size. Corresponds to the number of values around each point used to compute the mean value. |
vpImageException::notInitializedError | : Histogram array not initialised. Means that the histogram was not calculated before. |
Definition at line 529 of file vpHistogram.cpp.
References vpImageException::notInitializedError.
unsigned vpHistogram::sort | ( | std::list< vpHistogramPeak > & | peaks | ) |
Sort a list of histogram peaks from highest to the lowest.
peaks | : List of histogram peaks. |
Definition at line 1144 of file vpHistogram.cpp.
Referenced by getPeaks().
bool vpHistogram::write | ( | const char * | filename | ) |
Write the histogram values in a file.
In the file, on each line you will find first the gray level and than the number of pixels which have this gray level.
filename | : File name to write with histogram values. |
Definition at line 1182 of file vpHistogram.cpp.
bool vpHistogram::write | ( | const std::string & | filename | ) |
Write the histogram values in a file.
In the file, on each line you will find first the gray level and than the number of pixels which have this gray level.
filename | : File name to write with histogram values. |
Definition at line 1168 of file vpHistogram.cpp.