W3cubDocs

/PointCloudLibrary

PCL simple buffer visualizer main class. More...

#include <pcl/visualization/simple_buffer_visualizer.h>

Public Member Functions

PCLSimpleBufferVisualizer ()
PCL simple buffer visualizer visualizer default constructor. More...
PCLSimpleBufferVisualizer (const int nb_values)
PCL simple buffer visualizer visualizer constructor. More...
void displayValues (const int time=1)
force display of values. More...
void addValue (const float val)
add a new value at the end of the buffer. More...
void spinOnce (const int time=1)
spinOnce method. More...
void spin ()
spin method. More...
void setAutomaticBackgroundColorControl (const bool value=true, const float threshold=0.0f)
set background color handling mode. More...
void setManuallyManageYScale (const bool value=false)
set Y scale policy. More...

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 19 of file simple_buffer_visualizer.h.

Constructor & Destructor Documentation

PCLSimpleBufferVisualizer() [1/2]

pcl::visualization::PCLSimpleBufferVisualizer::PCLSimpleBufferVisualizer ( )
inline

PCL simple buffer visualizer visualizer default constructor.

Definition at line 23 of file simple_buffer_visualizer.h.

PCLSimpleBufferVisualizer() [2/2]

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 35 of file simple_buffer_visualizer.h.

Member Function Documentation

addValue()

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 95 of file simple_buffer_visualizer.h.

displayValues()

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 60 of file simple_buffer_visualizer.h.

setAutomaticBackgroundColorControl()

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 134 of file simple_buffer_visualizer.h.

setManuallyManageYScale()

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 151 of file simple_buffer_visualizer.h.

spin()

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

spin method.

Definition at line 122 of file simple_buffer_visualizer.h.

spinOnce()

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 115 of file simple_buffer_visualizer.h.


The documentation for this class was generated from the following file:

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1visualization_1_1_p_c_l_simple_buffer_visualizer.html