openni_wrapper::Image Class Reference

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. More...

#include <openni_image.h>

Inheritance diagram for openni_wrapper::Image:

Public Types
typedef boost::shared_ptr< const Image >	ConstPtr
enum	Encoding { BAYER_GRBG, YUV422, RGB }
typedef boost::shared_ptr< Image >	Ptr

Public Member Functions
virtual void	fillGrayscale (unsigned width, unsigned height, unsigned char *gray_buffer, unsigned gray_line_step=0) const =0 throw (OpenNIException)
void	fillRaw (unsigned char *rgb_buffer) const throw (OpenNIException)
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
unsigned	getFrameID () const throw ()
unsigned	getHeight () const throw ()
const xn::ImageMetaData &	getMetaData () const throw ()
const boost::shared_ptr< xn::ImageMetaData >	getMetaDataPtr () const
unsigned long	getTimeStamp () const throw ()
unsigned	getWidth () const throw ()
	Image (boost::shared_ptr< xn::ImageMetaData > image_meta_data) throw ()
virtual bool	isResizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const =0
virtual	~Image () 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 54 of file openni_image.h.

Member Typedef Documentation

ConstPtr

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

Definition at line 58 of file openni_image.h.

Ptr

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

Definition at line 57 of file openni_image.h.

Member Enumeration Documentation

Encoding

enum openni_wrapper::Image::Encoding

Enumerator
BAYER_GRBG
YUV422
RGB

Definition at line 60 of file openni_image.h.

Constructor & Destructor Documentation

Image()

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

inline

Definition at line 96 of file openni_image.h.

~Image()

openni_wrapper::Image::~Image ( ) throw ( )

inlinevirtual

Definition at line 101 of file openni_image.h.

Member Function Documentation

fillGrayscale()

virtual void openni_wrapper::Image::fillGrayscale ( unsigned  width, unsigned  height, unsigned char *  gray_buffer, unsigned  gray_line_step = 0  ) const throw ( OpenNIException )

pure virtual

Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.

fillRaw()

void openni_wrapper::Image::fillRaw ( unsigned char *  rgb_buffer ) const throw ( OpenNIException )

inline

Definition at line 77 of file openni_image.h.

fillRGB()

virtual void openni_wrapper::Image::fillRGB ( unsigned  width, unsigned  height, unsigned char *  rgb_buffer, unsigned  rgb_line_step = 0  ) const throw ( OpenNIException )

pure virtual

Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.

getEncoding()

virtual Encoding openni_wrapper::Image::getEncoding ( ) const

pure virtual

Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.

getFrameID()

unsigned openni_wrapper::Image::getFrameID ( ) const throw ( )

inline

Definition at line 115 of file openni_image.h.

getHeight()

unsigned openni_wrapper::Image::getHeight ( ) const throw ( )

inline

Definition at line 110 of file openni_image.h.

getMetaData()

const xn::ImageMetaData & openni_wrapper::Image::getMetaData ( ) const throw ( )

inline

Definition at line 125 of file openni_image.h.

getMetaDataPtr()

const boost::shared_ptr< xn::ImageMetaData > openni_wrapper::Image::getMetaDataPtr ( ) const

inline

Definition at line 130 of file openni_image.h.

getTimeStamp()

unsigned long openni_wrapper::Image::getTimeStamp ( ) const throw ( )

inline

Definition at line 120 of file openni_image.h.

getWidth()

unsigned openni_wrapper::Image::getWidth ( ) const throw ( )

inline

Definition at line 105 of file openni_image.h.

isResizingSupported()

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

pure virtual

Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.

Member Data Documentation

image_md_

boost::shared_ptr<xn::ImageMetaData> openni_wrapper::Image::image_md_

protected

Definition at line 93 of file openni_image.h.

---

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

• openni_image.h