pcl::visualization::ImageViewer Class Reference

ImageViewer is a class for 2D image visualization. More...

#include <pcl/visualization/image_viewer.h>

Inheritance diagram for pcl::visualization::ImageViewer:

List of all members.

Classes
struct	ExitCallback
struct	ExitMainLoopTimerCallback
Public Member Functions
	ImageViewer (const std::string &window_title="")
	Constructor.
virtual	~ImageViewer ()
	Destructor.
void	showMonoImage (const unsigned char *data, unsigned width, unsigned height)
	Show a monochrome 2D image on screen.
void	showRGBImage (const unsigned char *data, unsigned width, unsigned height)
	Show a 2D RGB image on screen.
void	showRGBImage (const pcl::PointCloud< pcl::PointXYZRGB > &data)
	Show a 2D image on screen, obtained from the RGB channel of a PointXYZRGB-type point cloud.
void	showRGBImage (const pcl::PointCloud< pcl::PointXYZRGBA > &data)
	Show a 2D image on screen, obtained from the RGB channel of a PointXYZRGBA-type point cloud.
void	showFloatImage (const float *data, unsigned int width, unsigned int height, float min_value=std::numeric_limits< float >::min(), float max_value=std::numeric_limits< float >::max(), bool grayscale=false)
	Show a 2D image (float) on screen.
void	showShortImage (const unsigned short *short_image, unsigned int width, unsigned int height, unsigned short min_value=std::numeric_limits< unsigned short >::min(), unsigned short max_value=std::numeric_limits< unsigned short >::max(), bool grayscale=false)
	Show a 2D image (unsigned short) on screen.
void	showAngleImage (const float *data, unsigned width, unsigned height)
	Show a 2D image on screen representing angle data.
void	showHalfAngleImage (const float *data, unsigned width, unsigned height)
	Show a 2D image on screen representing half angle data.
void	markPoint (size_t u, size_t v, Vector3ub fg_color, Vector3ub bg_color=red_color, float radius=2)
	Sets the pixel at coordinates(u,v) to color while setting the neighborhood to another.
void	setWindowTitle (const std::string &name)
	Set the window title name.
void	spin ()
	Spin method.
void	spinOnce (int time=1, bool force_redraw=false)
	Spin once method.
boost::signals2::connection	registerKeyboardCallback (void(*callback)(const pcl::visualization::KeyboardEvent &, void *), void *cookie=NULL)
	Register a callback function for keyboard events.
template<typename T >
boost::signals2::connection	registerKeyboardCallback (void(T::*callback)(const pcl::visualization::KeyboardEvent &, void *), T &instance, void *cookie=NULL)
	Register a callback function for keyboard events.
boost::signals2::connection	registerKeyboardCallback (boost::function< void(const pcl::visualization::KeyboardEvent &)> cb)
	Register a callback boost::function for keyboard events.
boost::signals2::connection	registerMouseCallback (void(*callback)(const pcl::visualization::MouseEvent &, void *), void *cookie=NULL)
	Register a callback boost::function for mouse events.
template<typename T >
boost::signals2::connection	registerMouseCallback (void(T::*callback)(const pcl::visualization::MouseEvent &, void *), T &instance, void *cookie=NULL)
	Register a callback function for mouse events.
boost::signals2::connection	registerMouseCallback (boost::function< void(const pcl::visualization::MouseEvent &)> cb)
	Register a callback function for mouse events.
void	setPosition (int x, int y)
	Set the position in screen coordinates.

---

Detailed Description

ImageViewer is a class for 2D image visualization.

Author:

Radu B. Rusu, Suat Gedikli

Definition at line 66 of file image_viewer.h.

---

Constructor & Destructor Documentation

pcl::visualization::ImageViewer::ImageViewer

(

const std::string &

window_title = ""

)

Constructor.

Parameters:

[in]

window_title

the title of the window

virtual pcl::visualization::ImageViewer::~ImageViewer

(

)

[virtual]

Destructor.

---

Member Function Documentation

void pcl::visualization::ImageViewer::markPoint	(	size_t	u,
		size_t	v,
		Vector3ub	fg_color,
		Vector3ub	bg_color = red_color,
		float	radius = 2
	)

Sets the pixel at coordinates(u,v) to color while setting the neighborhood to another.

Parameters:

[in]	u	the u/x coordinate of the pixel
[in]	v	the v/y coordinate of the pixel
[in]	fg_color	the pixel color
[in]	bg_color	the neighborhood color
[in]	radius	the circle radius around the pixel

boost::signals2::connection pcl::visualization::ImageViewer::registerKeyboardCallback	(	void(*)(const pcl::visualization::KeyboardEvent &, void *)	callback,
		void *	cookie = NULL
	)		[inline]

Register a callback function for keyboard events.

Parameters:

[in]	callback	the function that will be registered as a callback for a keyboard event
[in]	cookie	user data that is passed to the callback

Returns:

a connection object that allows to disconnect the callback function.

Definition at line 184 of file image_viewer.h.

template<typename T >

boost::signals2::connection pcl::visualization::ImageViewer::registerKeyboardCallback	(	void(T::*)(const pcl::visualization::KeyboardEvent &, void *)	callback,
		T &	instance,
		void *	cookie = NULL
	)		[inline]

Register a callback function for keyboard events.

Parameters:

[in]	callback	the member function that will be registered as a callback for a keyboard event
[in]	instance	instance to the class that implements the callback function
[in]	cookie	user data that is passed to the callback

Returns:

a connection object that allows to disconnect the callback function.

Definition at line 197 of file image_viewer.h.

boost::signals2::connection pcl::visualization::ImageViewer::registerKeyboardCallback

(

boost::function< void(const pcl::visualization::KeyboardEvent &)>

cb

)

Register a callback boost::function for keyboard events.

Parameters:

[in]

cb

the boost function that will be registered as a callback for a keyboard event

Returns:

a connection object that allows to disconnect the callback function.

boost::signals2::connection pcl::visualization::ImageViewer::registerMouseCallback	(	void(*)(const pcl::visualization::MouseEvent &, void *)	callback,
		void *	cookie = NULL
	)		[inline]

Register a callback boost::function for mouse events.

Parameters:

[in]	callback	the function that will be registered as a callback for a mouse event
[in]	cookie	user data that is passed to the callback

Returns:

a connection object that allows to disconnect the callback function.

Definition at line 216 of file image_viewer.h.

template<typename T >

boost::signals2::connection pcl::visualization::ImageViewer::registerMouseCallback	(	void(T::*)(const pcl::visualization::MouseEvent &, void *)	callback,
		T &	instance,
		void *	cookie = NULL
	)		[inline]

Register a callback function for mouse events.

Parameters:

[in]	callback	the member function that will be registered as a callback for a mouse event
[in]	instance	instance to the class that implements the callback function
[in]	cookie	user data that is passed to the callback

Returns:

a connection object that allows to disconnect the callback function.

Definition at line 229 of file image_viewer.h.

boost::signals2::connection pcl::visualization::ImageViewer::registerMouseCallback

(

boost::function< void(const pcl::visualization::MouseEvent &)>

cb

)

Register a callback function for mouse events.

Parameters:

[in]

cb

the boost function that will be registered as a callback for a mouse event

Returns:

a connection object that allows to disconnect the callback function.

void pcl::visualization::ImageViewer::setPosition	(	int	x,
		int	y
	)		[inline]

Set the position in screen coordinates.

Parameters:

[in]	x	where to move the window to (X)
[in]	y	where to move the window to (Y)

Definition at line 247 of file image_viewer.h.

void pcl::visualization::ImageViewer::setWindowTitle

(

const std::string &

name

)

[inline]

Set the window title name.

Parameters:

[in]

name

the window title

Definition at line 161 of file image_viewer.h.

void pcl::visualization::ImageViewer::showAngleImage	(	const float *	data,
		unsigned	width,
		unsigned	height
	)

Show a 2D image on screen representing angle data.

Parameters:

[in]	data	the input data representing the image
[in]	width	the width of the image
[in]	height	the height of the image

void pcl::visualization::ImageViewer::showFloatImage	(	const float *	data,
		unsigned int	width,
		unsigned int	height,
		float	min_value = std::numeric_limits< float >::min(),
		float	max_value = std::numeric_limits< float >::max(),
		bool	grayscale = false
	)

Show a 2D image (float) on screen.

Parameters:

[in]	data	the input data representing the image in float format
[in]	width	the width of the image
[in]	height	the height of the image
[in]	min_value	filter all values in the image to be larger than this minimum value
[in]	max_value	filter all values in the image to be smaller than this maximum value
[in]	grayscale	show data as grayscale (true) or not (false). Default: false

void pcl::visualization::ImageViewer::showHalfAngleImage	(	const float *	data,
		unsigned	width,
		unsigned	height
	)

Show a 2D image on screen representing half angle data.

Parameters:

[in]	data	the input data representing the image
[in]	width	the width of the image
[in]	height	the height of the image

void pcl::visualization::ImageViewer::showMonoImage	(	const unsigned char *	data,
		unsigned	width,
		unsigned	height
	)

Show a monochrome 2D image on screen.

Parameters:

[in]	data	the input data representing the image
[in]	width	the width of the image
[in]	height	the height of the image

void pcl::visualization::ImageViewer::showRGBImage	(	const unsigned char *	data,
		unsigned	width,
		unsigned	height
	)

Show a 2D RGB image on screen.

Parameters:

[in]	data	the input data representing the image
[in]	width	the width of the image
[in]	height	the height of the image

void pcl::visualization::ImageViewer::showRGBImage

(

const pcl::PointCloud< pcl::PointXYZRGB > &

data

)

Show a 2D image on screen, obtained from the RGB channel of a PointXYZRGB-type point cloud.

Parameters:

[in]

data

the input data representing the PointXYZRGB point cloud

void pcl::visualization::ImageViewer::showRGBImage

(

const pcl::PointCloud< pcl::PointXYZRGBA > &

data

)

Show a 2D image on screen, obtained from the RGB channel of a PointXYZRGBA-type point cloud.

Parameters:

[in]

data

the input data representing the PointXYZRGBA point cloud

void pcl::visualization::ImageViewer::showShortImage	(	const unsigned short *	short_image,
		unsigned int	width,
		unsigned int	height,
		unsigned short	min_value = std::numeric_limits< unsigned short >::min(),
		unsigned short	max_value = std::numeric_limits< unsigned short >::max(),
		bool	grayscale = false
	)

Show a 2D image (unsigned short) on screen.

Parameters:

[in]	short_image	the input data representing the image in unsigned short format
[in]	width	the width of the image
[in]	height	the height of the image
[in]	min_value	filter all values in the image to be larger than this minimum value
[in]	max_value	filter all values in the image to be smaller than this maximum value
[in]	grayscale	show data as grayscale (true) or not (false). Default: false

void pcl::visualization::ImageViewer::spin

(

)

Spin method.

Calls the interactor and runs an internal loop.

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

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.
[in]	force_redraw	- if false it might return without doing anything if the interactor's framerate does not require a redraw yet.

---

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

• /builddir/build/BUILD/PCL-1.5.1-Source/visualization/include/pcl/visualization/image_viewer.h