Classes | Public Member Functions

pcl::visualization::PCLHistogramVisualizer Class Reference
[Module visualization]

PCL histogram visualizer main class. More...

#include <pcl/visualization/histogram_visualizer.h>

List of all members.

Classes

struct  ExitCallback
struct  ExitMainLoopTimerCallback

Public Member Functions

 PCLHistogramVisualizer ()
 PCL histogram visualizer constructor.
 ~PCLHistogramVisualizer ()
void spinOnce (int time=1, bool force_redraw=false)
 Spin once method.
void spin ()
 Spin method.
void setBackgroundColor (const double &r, const double &g, const double &b, int viewport=0)
 Set the viewport's background color.
template<typename PointT >
bool addFeatureHistogram (const pcl::PointCloud< PointT > &cloud, int hsize, const std::string &id="cloud", int win_width=640, int win_height=200)
 Add a histogram feature to screen as a separate window.
bool addFeatureHistogram (const sensor_msgs::PointCloud2 &cloud, const std::string &field_name, const std::string &id="cloud", int win_width=640, int win_height=200)
 Add a histogram feature to screen as a separate window.
void setGlobalYRange (float minp, float maxp)
 Set the Y range to minp-maxp for all histograms.
void updateWindowPositions ()
 Update all window positions on screen so that they fit.
bool wasStopped ()
 Returns true when the user tried to close the window.
void resetStoppedFlag ()
 Set the stopped flag back to false.

Detailed Description

PCL histogram visualizer main class.

Author:
Radu Bogdan Rusu

Definition at line 59 of file histogram_visualizer.h.


Constructor & Destructor Documentation

pcl::visualization::PCLHistogramVisualizer::PCLHistogramVisualizer (  ) 

PCL histogram visualizer constructor.

pcl::visualization::PCLHistogramVisualizer::~PCLHistogramVisualizer (  ) 

Member Function Documentation

template<typename PointT >
bool pcl::visualization::PCLHistogramVisualizer::addFeatureHistogram ( const pcl::PointCloud< PointT > &  cloud,
int  hsize,
const std::string &  id = "cloud",
int  win_width = 640,
int  win_height = 200 
)

Add a histogram feature to screen as a separate window.

Parameters:
cloud the PointCloud dataset containing the histogram
hsize the length of the histogram
id the point cloud object id (default: cloud)
win_width the size of the window (width)
win_height the size of the window (width)

Definition at line 40 of file histogram_visualizer.hpp.

bool pcl::visualization::PCLHistogramVisualizer::addFeatureHistogram ( const sensor_msgs::PointCloud2 cloud,
const std::string &  field_name,
const std::string &  id = "cloud",
int  win_width = 640,
int  win_height = 200 
)

Add a histogram feature to screen as a separate window.

Parameters:
cloud the PointCloud dataset containing the histogram
field_name the field name containing the histogram
id the point cloud object id (default: cloud)
win_width the size of the window (width)
win_height the size of the window (width)
void pcl::visualization::PCLHistogramVisualizer::resetStoppedFlag (  ) 

Set the stopped flag back to false.

void pcl::visualization::PCLHistogramVisualizer::setBackgroundColor ( const double &  r,
const double &  g,
const double &  b,
int  viewport = 0 
)

Set the viewport's background color.

Parameters:
r the red component of the RGB color
g the green component of the RGB color
b the blue component of the RGB color
viewport the view port (default: all)
void pcl::visualization::PCLHistogramVisualizer::setGlobalYRange ( float  minp,
float  maxp 
)

Set the Y range to minp-maxp for all histograms.

Parameters:
minp the minimum Y range
maxp the maximum Y range
void pcl::visualization::PCLHistogramVisualizer::spin (  ) 

Spin method.

Calls the interactor and runs an internal loop.

void pcl::visualization::PCLHistogramVisualizer::spinOnce ( int  time = 1,
bool  force_redraw = false 
)

Spin once method.

Calls the interactor and updates the screen once.

Parameters:
time - How long (in ms) should the visualization loop be allowed to run.
force_redraw - if false it might return without doing anything if the interactor's framerate does not require a redraw yet.
void pcl::visualization::PCLHistogramVisualizer::updateWindowPositions (  ) 

Update all window positions on screen so that they fit.

bool pcl::visualization::PCLHistogramVisualizer::wasStopped (  ) 

Returns true when the user tried to close the window.


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