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

PCL histogram visualizer main class. More...

#include <pcl/visualization/histogram_visualizer.h>

Classes
struct	ExitCallback
struct	ExitMainLoopTimerCallback
Public Member Functions
	PCLHistogramVisualizer ()
	PCL histogram visualizer constructor.
virtual	~PCLHistogramVisualizer ()
void	spinOnce (int time=1)
	Spin once method.
void	spin ()
	Spin method.
void	setBackgroundColor (const double &r, const double &g, const double &b)
	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, 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.
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	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.
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.

Detailed Description

PCL histogram visualizer main class.

Author:: Radu Bogdan Rusu

Definition at line 56 of file histogram_visualizer.h.

Constructor & Destructor Documentation

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

PCL histogram visualizer constructor.

virtual pcl::visualization::PCLHistogramVisualizer::~PCLHistogramVisualizer ( ) [inline, virtual]

Definition at line 62 of file histogram_visualizer.h.

Member Function Documentation

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]`	cloud	the PointCloud dataset containing the histogram
`[in]`	field_name	the field name containing the histogram
`[in]`	index	the point index to extract the histogram from
`[in]`	id	the point cloud object id (default: cloud)
`[in]`	win_width	the width of the window
`[in]`	win_height	the height of the window

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`
	)			`[inline]`

Add a histogram feature to screen as a separate window.

Parameters:

`[in]`	cloud	the PointCloud dataset containing the histogram
`[in]`	field_name	the field name containing the histogram
`[in]`	index	the point index to extract the histogram from
`[in]`	id	the point cloud object id (default: cloud)
`[in]`	win_width	the width of the window
`[in]`	win_height	the height of the window

Definition at line 82 of file histogram_visualizer.hpp.

References createActor(), and pcl::PointCloud< PointT >::points.

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]`	cloud	the PointCloud dataset containing the histogram
`[in]`	field_name	the field name containing the histogram
`[in]`	id	the point cloud object id (default: cloud)
`[in]`	win_width	the width of the window
`[in]`	win_height	the height of the window

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`
	)			`[inline]`

Add a histogram feature to screen as a separate window, from a cloud containing a single histogram.

Parameters:

`[in]`	cloud	the PointCloud dataset containing the histogram
`[in]`	hsize	the length of the histogram
`[in]`	id	the point cloud object id (default: cloud)
`[in]`	win_width	the width of the window
`[in]`	win_height	the height of the window

Definition at line 46 of file histogram_visualizer.hpp.

References createActor(), and pcl::PointCloud< PointT >::points.

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_array	the input vtkDoubleArray holding the histogram data
`[out]`	renwinint	the resultant render window interactor holding the rendered object
`[in]`	id	the point cloud object id
`[in]`	win_width	the width of the window
`[in]`	win_height	the height of the window

Referenced by addFeatureHistogram().

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_array	the input vtkDoubleArray holding the histogram data
`[out]`	renwinint	the resultant render window interactor holding the rendered object
`[in]`	id	the point cloud object id

Referenced by updateFeatureHistogram().

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

Set the viewport's background color.

Parameters:

`[in]`	r	the red component of the RGB color
`[in]`	g	the green component of the RGB color
`[in]`	b	the blue component of the RGB color

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

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

Parameters:

`[in]`	minp	the minimum Y range
`[in]`	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 )

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.

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]`	cloud	the PointCloud dataset containing the histogram
`[in]`	field_name	the field name containing the histogram
`[in]`	index	the point index to extract the histogram from
`[in]`	id	the point cloud object id (default: cloud)

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"`
	)			`[inline]`

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

Parameters:

`[in]`	cloud	the PointCloud dataset containing the histogram
`[in]`	field_name	the field name containing the histogram
`[in]`	index	the point index to extract the histogram from
`[in]`	id	the point cloud object id (default: cloud)

Definition at line 169 of file histogram_visualizer.hpp.

References pcl::PointCloud< PointT >::points, and reCreateActor().

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]`	cloud	the PointCloud dataset containing the histogram
`[in]`	field_name	the field name containing the histogram
`[in]`	id	the point cloud object id (default: cloud)

template<typename PointT >

bool pcl::visualization::PCLHistogramVisualizer::updateFeatureHistogram	(	const pcl::PointCloud< PointT > &	cloud,
		int	hsize,
		const std::string &	id = `"cloud"`
	)			`[inline]`

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

Parameters:

`[in]`	cloud	the PointCloud dataset containing the histogram
`[in]`	hsize	the length of the histogram
`[in]`	id	the point cloud object id (default: cloud)

Definition at line 139 of file histogram_visualizer.hpp.

References pcl::PointCloud< PointT >::points, and reCreateActor().

void pcl::visualization::PCLHistogramVisualizer::updateWindowPositions ( )

Update all window positions on screen so that they fit.

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

/builddir/build/BUILD/pcl-pcl-1.7.1/visualization/include/pcl/visualization/histogram_visualizer.h
/builddir/build/BUILD/pcl-pcl-1.7.1/visualization/include/pcl/visualization/impl/histogram_visualizer.hpp

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

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

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