Image class containing just a reference to image meta data. More...
#include <pcl/io/openni_camera/openni_image.h>
Public Types | |
| enum | Encoding { BAYER_GRBG, YUV422, RGB } |
| typedef boost::shared_ptr< Image > | Ptr |
| typedef boost::shared_ptr < const Image > | ConstPtr |
Public Member Functions | |
| Image (boost::shared_ptr< xn::ImageMetaData > image_meta_data) throw () | |
| Constructor. | |
| virtual | ~Image () throw () |
| virtual Destructor that never throws an exception. | |
| 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 |
| fills a user given buffer with the RGB values, with an optional nearest-neighbor down sampling and an optional subregion | |
| virtual Encoding | getEncoding () const =0 |
| returns the encoding of the native data. | |
| void | fillRaw (unsigned char *rgb_buffer) const throw () |
| fills a user given buffer with the raw values. | |
| virtual void | fillGrayscale (unsigned width, unsigned height, unsigned char *gray_buffer, unsigned gray_line_step=0) const =0 |
| fills a user given buffer with the gray values, with an optional nearest-neighbor down sampling and an optional subregion | |
| 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_ |
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.
| [in] | image_meta_data |
Definition at line 58 of file openni_image.h.
| 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.
Definition at line 64 of file openni_image.h.
| openni_wrapper::Image::Image | ( | boost::shared_ptr< xn::ImageMetaData > | image_meta_data | ) | throw () [inline] |
Constructor.
| [in] | image_meta_data | the actual image data from the OpenNI driver |
Definition at line 171 of file openni_image.h.
| openni_wrapper::Image::~Image | ( | ) | throw () [inline, virtual] |
virtual Destructor that never throws an exception.
Definition at line 176 of file openni_image.h.
| virtual void openni_wrapper::Image::fillGrayscale | ( | unsigned | width, | |
| unsigned | height, | |||
| unsigned char * | gray_buffer, | |||
| unsigned | gray_line_step = 0 | |||
| ) | const [pure virtual] |
fills a user given buffer with the gray values, with an optional nearest-neighbor down sampling and an optional subregion
| [in] | width | desired width of output image. |
| [in] | height | desired height of output image. |
| [in,out] | gray_buffer | the output gray buffer. |
| [in] | gray_line_step | optional line step in bytes to allow the output in a rectangular subregion of the output buffer. |
Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.
| void openni_wrapper::Image::fillRaw | ( | unsigned char * | rgb_buffer | ) | const throw () [inline] |
fills a user given buffer with the raw values.
| [in,out] | rgb_buffer |
Definition at line 119 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 [pure virtual] |
fills a user given buffer with the RGB values, with an optional nearest-neighbor down sampling and an optional subregion
| [in] | width | desired width of output image. |
| [in] | height | desired height of output image. |
| [in,out] | rgb_buffer | the output RGB buffer. |
| [in] | rgb_line_step | optional line step in bytes to allow the output in a rectangular subregion of the output buffer. |
Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.
| virtual Encoding openni_wrapper::Image::getEncoding | ( | ) | const [pure virtual] |
returns the encoding of the native data.
Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.
| unsigned openni_wrapper::Image::getFrameID | ( | ) | const throw () [inline] |
Definition at line 191 of file openni_image.h.
References image_md_.
| unsigned openni_wrapper::Image::getHeight | ( | ) | const throw () [inline] |
| const xn::ImageMetaData & openni_wrapper::Image::getMetaData | ( | ) | const throw () [inline] |
Definition at line 203 of file openni_image.h.
References image_md_.
| unsigned long openni_wrapper::Image::getTimeStamp | ( | ) | const throw () [inline] |
Definition at line 197 of file openni_image.h.
References image_md_.
| unsigned openni_wrapper::Image::getWidth | ( | ) | const throw () [inline] |
| virtual bool openni_wrapper::Image::isResizingSupported | ( | unsigned | input_width, | |
| unsigned | input_height, | |||
| unsigned | output_width, | |||
| unsigned | output_height | |||
| ) | const [pure virtual] |
| [in] | input_width | width of input image |
| [in] | input_height | height of input image |
| [in] | output_width | width of desired output image |
| [in] | output_height | height of desired output image |
Implemented in openni_wrapper::ImageBayerGRBG, openni_wrapper::ImageRGB24, and openni_wrapper::ImageYUV422.
boost::shared_ptr<xn::ImageMetaData> openni_wrapper::Image::image_md_ [protected] |
Definition at line 168 of file openni_image.h.
Referenced by getFrameID(), getHeight(), getMetaData(), getTimeStamp(), and getWidth().
