Classes | Public Member Functions | Protected Member Functions | Private Attributes
pcl::visualization::PCLHistogramVisualizer Class Reference

PCL histogram visualizer main class. More...

#include <histogram_visualizer.h>

List of all members.

Classes

struct  ExitCallback
struct  ExitMainLoopTimerCallback

Public Member Functions

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, from a cloud containing a single histogram.
bool addFeatureHistogram (const pcl::PCLPointCloud2 &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 from a cloud containing a single histogram.
template<typename PointT >
bool addFeatureHistogram (const pcl::PointCloud< PointT > &cloud, const std::string &field_name, const int index, 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 pcl::PCLPointCloud2 &cloud, const std::string &field_name, const int index, const std::string &id="cloud", int win_width=640, int win_height=200)
 Add a histogram feature to screen as a separate window.
 PCLHistogramVisualizer ()
 PCL histogram visualizer constructor.
void setBackgroundColor (const double &r, const double &g, const double &b)
 Set the viewport's background color.
void setGlobalYRange (float minp, float maxp)
 Set the Y range to minp-maxp for all histograms.
void spin ()
 Spin method. Calls the interactor and runs an internal loop.
void spinOnce (int time=1)
 Spin once method. Calls the interactor and updates the screen once.
template<typename PointT >
bool updateFeatureHistogram (const pcl::PointCloud< PointT > &cloud, int hsize, const std::string &id="cloud")
 Update a histogram feature that is already on screen, with a cloud containing a single histogram.
bool updateFeatureHistogram (const pcl::PCLPointCloud2 &cloud, const std::string &field_name, const std::string &id="cloud")
 Update a histogram feature that is already on screen, with a cloud containing a single histogram.
template<typename PointT >
bool updateFeatureHistogram (const pcl::PointCloud< PointT > &cloud, const std::string &field_name, const int index, const std::string &id="cloud")
 Update a histogram feature that is already on screen, with a cloud containing a single histogram.
bool updateFeatureHistogram (const pcl::PCLPointCloud2 &cloud, const std::string &field_name, const int index, const std::string &id="cloud")
 Update a histogram feature that is already on screen, with a cloud containing a single histogram.
void updateWindowPositions ()
 Update all window positions on screen so that they fit.
virtual ~PCLHistogramVisualizer ()

Protected Member Functions

void createActor (const vtkSmartPointer< vtkDoubleArray > &xy_array, RenWinInteract &renwinint, const std::string &id, const int win_width, const int win_height)
 Create a 2D actor from the given vtkDoubleArray histogram and add it to the screen.
void reCreateActor (const vtkSmartPointer< vtkDoubleArray > &xy_array, RenWinInteract *renwinupd, const int hsize)
 Remove the current 2d actor and create a new 2D actor from the given vtkDoubleArray histogram and add it to the screen.

Private Attributes

vtkSmartPointer< ExitCallbackexit_callback_
vtkSmartPointer
< ExitMainLoopTimerCallback
exit_main_loop_timer_callback_
 Callback object enabling us to leave the main loop, when a timer fires.
bool stopped_
 Set to true when the histogram visualizer is ready to be terminated.
RenWinInteractMap wins_
 A map of all windows on screen (with their renderers and interactors).

Detailed Description

PCL histogram visualizer main class.

Author:
Radu Bogdan Rusu

Definition at line 56 of file histogram_visualizer.h.


Constructor & Destructor Documentation

PCL histogram visualizer constructor.

Definition at line 59 of file histogram_visualizer.cpp.

Definition at line 62 of file histogram_visualizer.h.


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, from a cloud containing a single histogram.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]hsizethe length of the histogram
[in]idthe point cloud object id (default: cloud)
[in]win_widththe width of the window
[in]win_heightthe height of the window

Definition at line 46 of file histogram_visualizer.hpp.

bool pcl::visualization::PCLHistogramVisualizer::addFeatureHistogram ( const pcl::PCLPointCloud2 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 from a cloud containing a single histogram.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]field_namethe field name containing the histogram
[in]idthe point cloud object id (default: cloud)
[in]win_widththe width of the window
[in]win_heightthe height of the window

Definition at line 373 of file histogram_visualizer.cpp.

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

Add a histogram feature to screen as a separate window.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]field_namethe field name containing the histogram
[in]indexthe point index to extract the histogram from
[in]idthe point cloud object id (default: cloud)
[in]win_widththe width of the window
[in]win_heightthe height of the window

Definition at line 82 of file histogram_visualizer.hpp.

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

Add a histogram feature to screen as a separate window.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]field_namethe field name containing the histogram
[in]indexthe point index to extract the histogram from
[in]idthe point cloud object id (default: cloud)
[in]win_widththe width of the window
[in]win_heightthe height of the window

Definition at line 420 of file histogram_visualizer.cpp.

void pcl::visualization::PCLHistogramVisualizer::createActor ( const vtkSmartPointer< vtkDoubleArray > &  xy_array,
RenWinInteract renwinint,
const std::string id,
const int  win_width,
const int  win_height 
) [protected]

Create a 2D actor from the given vtkDoubleArray histogram and add it to the screen.

Parameters:
[in]xy_arraythe input vtkDoubleArray holding the histogram data
[out]renwinintthe resultant render window interactor holding the rendered object
[in]idthe point cloud object id
[in]win_widththe width of the window
[in]win_heightthe height of the window

Definition at line 286 of file histogram_visualizer.cpp.

void pcl::visualization::PCLHistogramVisualizer::reCreateActor ( const vtkSmartPointer< vtkDoubleArray > &  xy_array,
RenWinInteract renwinupd,
const int  hsize 
) [protected]

Remove the current 2d actor and create a new 2D actor from the given vtkDoubleArray histogram and add it to the screen.

Parameters:
[in]xy_arraythe input vtkDoubleArray holding the histogram data
[out]renwinintthe resultant render window interactor holding the rendered object
[in]idthe point cloud object id

Definition at line 259 of file histogram_visualizer.cpp.

void pcl::visualization::PCLHistogramVisualizer::setBackgroundColor ( const double &  r,
const double &  g,
const double &  b 
)

Set the viewport's background color.

Parameters:
[in]rthe red component of the RGB color
[in]gthe green component of the RGB color
[in]bthe blue component of the RGB color

Definition at line 188 of file histogram_visualizer.cpp.

void pcl::visualization::PCLHistogramVisualizer::setGlobalYRange ( float  minp,
float  maxp 
)

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

Parameters:
[in]minpthe minimum Y range
[in]maxpthe maximum Y range

Definition at line 219 of file histogram_visualizer.cpp.

Spin method. Calls the interactor and runs an internal loop.

Definition at line 172 of file histogram_visualizer.cpp.

Spin once method. Calls the interactor and updates the screen once.

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

Definition at line 113 of file histogram_visualizer.cpp.

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

Update a histogram feature that is already on screen, with a cloud containing a single histogram.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]hsizethe length of the histogram
[in]idthe point cloud object id (default: cloud)

Definition at line 139 of file histogram_visualizer.hpp.

bool pcl::visualization::PCLHistogramVisualizer::updateFeatureHistogram ( const pcl::PCLPointCloud2 cloud,
const std::string field_name,
const std::string id = "cloud" 
)

Update a histogram feature that is already on screen, with a cloud containing a single histogram.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]field_namethe field name containing the histogram
[in]idthe point cloud object id (default: cloud)

Definition at line 480 of file histogram_visualizer.cpp.

template<typename PointT >
bool pcl::visualization::PCLHistogramVisualizer::updateFeatureHistogram ( const pcl::PointCloud< PointT > &  cloud,
const std::string field_name,
const int  index,
const std::string id = "cloud" 
)

Update a histogram feature that is already on screen, with a cloud containing a single histogram.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]field_namethe field name containing the histogram
[in]indexthe point index to extract the histogram from
[in]idthe point cloud object id (default: cloud)

Definition at line 169 of file histogram_visualizer.hpp.

bool pcl::visualization::PCLHistogramVisualizer::updateFeatureHistogram ( const pcl::PCLPointCloud2 cloud,
const std::string field_name,
const int  index,
const std::string id = "cloud" 
)

Update a histogram feature that is already on screen, with a cloud containing a single histogram.

Parameters:
[in]cloudthe PointCloud dataset containing the histogram
[in]field_namethe field name containing the histogram
[in]indexthe point index to extract the histogram from
[in]idthe point cloud object id (default: cloud)

Definition at line 519 of file histogram_visualizer.cpp.

Update all window positions on screen so that they fit.

Definition at line 230 of file histogram_visualizer.cpp.


Member Data Documentation

Definition at line 260 of file histogram_visualizer.h.

Callback object enabling us to leave the main loop, when a timer fires.

Definition at line 259 of file histogram_visualizer.h.

Set to true when the histogram visualizer is ready to be terminated.

Definition at line 262 of file histogram_visualizer.h.

A map of all windows on screen (with their renderers and interactors).

Definition at line 224 of file histogram_visualizer.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:47:19