Public Types | Public Member Functions | Protected Attributes

openni_wrapper::Image Class Reference
[Module io]

Image class containing just a reference to image meta data. More...

#include <pcl/io/openni_camera/openni_image.h>

Inheritance diagram for openni_wrapper::Image:
Inheritance graph
[legend]

List of all members.

Public Types

enum  Encoding { BAYER_GRBG, YUV422 }
typedef boost::shared_ptr< ImagePtr
typedef boost::shared_ptr
< const Image
ConstPtr

Public Member Functions

 Image (boost::shared_ptr< xn::ImageMetaData > image_meta_data) throw ()
virtual ~Image () throw ()
virtual bool isResizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const =0
virtual void fillRGB (unsigned width, unsigned height, unsigned char *rgb_buffer, unsigned rgb_line_step=0) const =0 throw (OpenNIException)
virtual Encoding getEncoding () const =0
void fillRaw (unsigned char *rgb_buffer) const throw (OpenNIException)
virtual void fillGrayscale (unsigned width, unsigned height, unsigned char *gray_buffer, unsigned gray_line_step=0) const =0 throw (OpenNIException)
unsigned getWidth () const throw ()
unsigned getHeight () const throw ()
unsigned getFrameID () const throw ()
unsigned long getTimeStamp () const throw ()
const xn::ImageMetaData & getMetaData () const throw ()

Protected Attributes

boost::shared_ptr
< xn::ImageMetaData > 
image_md_

Detailed Description

Image class containing just a reference to image meta data.

Thus this class just provides an interface to fill a RGB or Grayscale image buffer.

Author:
Suat Gedikli
Date:
02.january 2011
Parameters:
image_meta_data 

Definition at line 58 of file openni_image.h.


Member Typedef Documentation

typedef boost::shared_ptr<const Image> openni_wrapper::Image::ConstPtr

Definition at line 62 of file openni_image.h.

typedef boost::shared_ptr<Image> openni_wrapper::Image::Ptr

Definition at line 61 of file openni_image.h.


Member Enumeration Documentation

Enumerator:
BAYER_GRBG 
YUV422 

Definition at line 64 of file openni_image.h.


Constructor & Destructor Documentation

openni_wrapper::Image::Image ( boost::shared_ptr< xn::ImageMetaData >  image_meta_data  )  throw () [inline]

Definition at line 98 of file openni_image.h.

openni_wrapper::Image::~Image (  )  throw () [inline, virtual]

Definition at line 103 of file openni_image.h.


Member Function Documentation

virtual void openni_wrapper::Image::fillGrayscale ( unsigned  width,
unsigned  height,
unsigned char *  gray_buffer,
unsigned  gray_line_step = 0 
) const throw (OpenNIException) [pure virtual]
void openni_wrapper::Image::fillRaw ( unsigned char *  rgb_buffer  )  const throw (OpenNIException) [inline]

Definition at line 80 of file openni_image.h.

virtual void openni_wrapper::Image::fillRGB ( unsigned  width,
unsigned  height,
unsigned char *  rgb_buffer,
unsigned  rgb_line_step = 0 
) const throw (OpenNIException) [pure virtual]
virtual Encoding openni_wrapper::Image::getEncoding (  )  const [pure virtual]
unsigned openni_wrapper::Image::getFrameID (  )  const throw () [inline]

Definition at line 117 of file openni_image.h.

unsigned openni_wrapper::Image::getHeight (  )  const throw () [inline]

Definition at line 112 of file openni_image.h.

const xn::ImageMetaData & openni_wrapper::Image::getMetaData (  )  const throw () [inline]

Definition at line 127 of file openni_image.h.

unsigned long openni_wrapper::Image::getTimeStamp (  )  const throw () [inline]

Definition at line 122 of file openni_image.h.

unsigned openni_wrapper::Image::getWidth (  )  const throw () [inline]

Definition at line 107 of file openni_image.h.

virtual bool openni_wrapper::Image::isResizingSupported ( unsigned  input_width,
unsigned  input_height,
unsigned  output_width,
unsigned  output_height 
) const [pure virtual]

Member Data Documentation

boost::shared_ptr<xn::ImageMetaData> openni_wrapper::Image::image_md_ [protected]

Definition at line 95 of file openni_image.h.


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