Point Cloud Library (PCL)  1.3.1
Classes | Public Member Functions
pcl::visualization::ImageViewer Class Reference

#include <pcl/visualization/image_viewer.h>

Inheritance diagram for pcl::visualization::ImageViewer:
Inheritance graph
[legend]

List of all members.

Classes

struct  ExitCallback
struct  ExitMainLoopTimerCallback

Public Member Functions

 ImageViewer (const std::string &window_title="")
virtual ~ImageViewer ()
void showRGBImage (const unsigned char *data, unsigned width, unsigned height)
void showRGBImage (const pcl::PointCloud< pcl::PointXYZRGB > &data)
void showFloatImage (const float *data, unsigned int width, unsigned int height, float min_value, float max_value, bool grayscale=false)
void showShortImage (const unsigned short *short_image, unsigned int width, unsigned int height, unsigned short min_value, unsigned short max_value, bool grayscale)
void showAngleImage (const float *data, unsigned width, unsigned height)
void showHalfAngleImage (const float *data, unsigned width, unsigned height)
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 setName (const std::string &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)
 registering 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)
 registering a callback function for keyboard events
boost::signals2::connection registerKeyboardCallback (boost::function< void(const pcl::visualization::KeyboardEvent &)>)
 registering a callback boost::function for keyboard events
boost::signals2::connection registerMouseCallback (void(*callback)(const pcl::visualization::MouseEvent &, void *), void *cookie=NULL)
template<typename T >
boost::signals2::connection registerMouseCallback (void(T::*callback)(const pcl::visualization::MouseEvent &, void *), T &instance, void *cookie=NULL)
 registering a callback function for mouse events
boost::signals2::connection registerMouseCallback (boost::function< void(const pcl::visualization::MouseEvent &)>)
 registering a callback function for mouse events

Constructor & Destructor Documentation

pcl::visualization::ImageViewer::ImageViewer ( const std::string &  window_title = "")
virtual pcl::visualization::ImageViewer::~ImageViewer ( ) [virtual]

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:
fg_colorthe pixel color
bg_colorthe neighborhood color
radiusthe circle radius around the pixel
boost::signals2::connection pcl::visualization::ImageViewer::registerKeyboardCallback ( void(*)(const pcl::visualization::KeyboardEvent &, void *)  callback,
void *  cookie = NULL 
) [inline]

registering a callback function for keyboard events

Parameters:
callbackthe function that will be registered as a callback for a keyboard event
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 120 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]

registering a callback function for keyboard events

Parameters:
callbackthe member function that will be registered as a callback for a keyboard event
instanceinstance to the class that implements the callback function
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 133 of file image_viewer.h.

boost::signals2::connection pcl::visualization::ImageViewer::registerKeyboardCallback ( boost::function< void(const pcl::visualization::KeyboardEvent &)>  )

registering a callback boost::function for keyboard events

Parameters:
theboost function that will be registered as a callback for a keyboard event
Returns:
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]
Parameters:
callbackthe function that will be registered as a callback for a mouse event
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 152 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]

registering a callback function for mouse events

Parameters:
callbackthe member function that will be registered as a callback for a mouse event
instanceinstance to the class that implements the callback function
cookieuser data that is passed to the callback
Returns:
connection object that allows to disconnect the callback function.

Definition at line 165 of file image_viewer.h.

boost::signals2::connection pcl::visualization::ImageViewer::registerMouseCallback ( boost::function< void(const pcl::visualization::MouseEvent &)>  )

registering a callback function for mouse events

Parameters:
theboost function that will be registered as a callback for a mouse event
Returns:
connection object that allows to disconnect the callback function.
void pcl::visualization::ImageViewer::setName ( const std::string &  name) [inline]

Definition at line 97 of file image_viewer.h.

void pcl::visualization::ImageViewer::showAngleImage ( const float *  data,
unsigned  width,
unsigned  height 
)
void pcl::visualization::ImageViewer::showFloatImage ( const float *  data,
unsigned int  width,
unsigned int  height,
float  min_value,
float  max_value,
bool  grayscale = false 
)
void pcl::visualization::ImageViewer::showHalfAngleImage ( const float *  data,
unsigned  width,
unsigned  height 
)
void pcl::visualization::ImageViewer::showRGBImage ( const unsigned char *  data,
unsigned  width,
unsigned  height 
)
void pcl::visualization::ImageViewer::showRGBImage ( const pcl::PointCloud< pcl::PointXYZRGB > &  data)
void pcl::visualization::ImageViewer::showShortImage ( const unsigned short *  short_image,
unsigned int  width,
unsigned int  height,
unsigned short  min_value,
unsigned short  max_value,
bool  grayscale 
)
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:
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.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines