PCL simple buffer visualizer main class. More...

#include <simple_buffer_visualizer.h>

Public Member Functions
void	addValue (const float val)
	add a new value at the end of the buffer.
void	displayValues (const int time=1)
	force display of values.
	PCLSimpleBufferVisualizer ()
	PCL simple buffer visualizer visualizer default constructor.
	PCLSimpleBufferVisualizer (const int nb_values)
	PCL simple buffer visualizer visualizer constructor.
void	setAutomaticBackgroundColorControl (const bool value=true, const float threshold=0.0f)
	set background color handling mode.
void	setManuallyManageYScale (const bool value=false)
	set Y scale policy.
void	spin ()
	spin method.
void	spinOnce (const int time=1)
	spinOnce method.
Private Member Functions
void	initGUIValues ()
	initialize private variables linked to the GUI
void	initValuesAndVisualization ()
	initialize ther buffer that stores the values to zero.
void	updateValuesToDisplay ()
	pushes the values contained inside the buffer to the cloud used for visualization.
Private Attributes
PointCloud< VFHSignature308 >	cloud_
	cloud used for visualization
bool	control_background_color_
	boolean used to know if we need to change the backgroud color in case of low values.
bool	handle_y_scale_
	boolean used to know if we need to change the backgroud color in case of low values. True means we do it ourselves.
PCLHistogramVisualizer *	histo_
	visualizer object
float	lowest_threshold_
	threshold to turn the background orange if latest value is lower.
float	max_
float	min_
	float tracking the minimal and maximal values ever observed.
int	nb_values_
	number of values stored in the buffer
std::deque< float >	values_
	buffer of values

Detailed Description

PCL simple buffer visualizer main class.

Note:: The idea is to offer a simple visualizer that stores and display the last X values as a curve.; The class is based on PCLHistogramVisualizer and pcl::VFHSignature308 for display.; Therefore, the number of values is limited to [2-308].

Author:: Raphael Favier

Definition at line 20 of file simple_buffer_visualizer.h.

Constructor & Destructor Documentation

pcl::visualization::PCLSimpleBufferVisualizer::PCLSimpleBufferVisualizer ( ) [inline]

PCL simple buffer visualizer visualizer default constructor.

Definition at line 24 of file simple_buffer_visualizer.h.

pcl::visualization::PCLSimpleBufferVisualizer::PCLSimpleBufferVisualizer ( const int nb_values ) [inline]

PCL simple buffer visualizer visualizer constructor.

Parameters:

[in] nb_values the number of values stored in the buffer [2 - 308]

Definition at line 36 of file simple_buffer_visualizer.h.

Member Function Documentation

void pcl::visualization::PCLSimpleBufferVisualizer::addValue ( const float val ) [inline]

add a new value at the end of the buffer.

Parameters:

[in] val the float value to add.

Definition at line 96 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::displayValues ( const int time = 1 ) [inline]

force display of values.

Parameters:

[in] time - How long (in ms) should the visualization loop be allowed to run

Definition at line 61 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::initGUIValues ( ) [inline, private]

initialize private variables linked to the GUI

Definition at line 188 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::initValuesAndVisualization ( ) [inline, private]

initialize ther buffer that stores the values to zero.

Note:: The size is set by private member nb_values_ which is in the range [2-308].

Definition at line 162 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::setAutomaticBackgroundColorControl	(	const bool	value = `true`,
		const float	threshold = `0.0f`
	)		`[inline]`

set background color handling mode.

Note:: The point here is to change the background to orange when the latest value is under a threshold.

Parameters:

[in]	value	if true, automatic mode is enabled. Else, background will be white
[in]	threshold	value that triggers the background to turn orange if the latest value is lower

Note:: This functionality does not work yet at time of commit (see http://dev.pointclouds.org/issues/829)

Definition at line 135 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::setManuallyManageYScale ( const bool value = false ) [inline]

set Y scale policy.

Note:: If set to true, the minimal and maximal Y values are kept forever.; If set to false, the Y scale is automatically adjusted to the current values (default).

Parameters:

[in] value boolean that enable or disable this policy

Definition at line 152 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::spin ( ) [inline]

spin method.

Definition at line 123 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::spinOnce ( const int time = 1 ) [inline]

spinOnce method.

Parameters:

[in] time - How long (in ms) should the visualization loop be allowed to run

Definition at line 116 of file simple_buffer_visualizer.h.

void pcl::visualization::PCLSimpleBufferVisualizer::updateValuesToDisplay ( ) [inline, private]