openni_wrapper::ImageRGB24 Class Reference

This class provides methods to fill a RGB or Grayscale image buffer from underlying RGB24 image. More...

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

Inheritance diagram for openni_wrapper::ImageRGB24:

Collaboration diagram for openni_wrapper::ImageRGB24:

Public Member Functions
	ImageRGB24 (pcl::shared_ptr< xn::ImageMetaData > image_meta_data) noexcept
	~ImageRGB24 () noexcept
Encoding	getEncoding () const override
	returns the encoding of the native data.
void	fillRGB (unsigned width, unsigned height, unsigned char *rgb_buffer, unsigned rgb_line_step=0) const override
	fills a user given buffer with the RGB values, with an optional nearest-neighbor down sampling and an optional subregion
void	fillGrayscale (unsigned width, unsigned height, unsigned char *gray_buffer, unsigned gray_line_step=0) const override
	fills a user given buffer with the gray values, with an optional nearest-neighbor down sampling and an optional subregion
bool	isResizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const override
Public Member Functions inherited from openni_wrapper::Image
	Image (pcl::shared_ptr< xn::ImageMetaData > image_meta_data) noexcept
	Constructor.
virtual	~Image () noexcept
	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 ()

Static Public Member Functions
static bool	resizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height)

Additional Inherited Members
Public Types inherited from openni_wrapper::Image
enum	Encoding { BAYER_GRBG , YUV422 , RGB }
using	Ptr = pcl::shared_ptr< Image >
using	ConstPtr = pcl::shared_ptr< const Image >
Protected Attributes inherited from openni_wrapper::Image
pcl::shared_ptr< xn::ImageMetaData >	image_md_

Detailed Description

This class provides methods to fill a RGB or Grayscale image buffer from underlying RGB24 image.

Author

Suat Gedikli

Date

19. June 2011

Definition at line 55 of file openni_image_rgb24.h.

Constructor & Destructor Documentation

ImageRGB24()

openni_wrapper::ImageRGB24::ImageRGB24 ( pcl::shared_ptr< xn::ImageMetaData >  image_meta_data )

noexcept

~ImageRGB24()

openni_wrapper::ImageRGB24::~ImageRGB24 ( )

noexcept

Member Function Documentation

fillGrayscale()

void openni_wrapper::ImageRGB24::fillGrayscale ( unsigned  width, unsigned  height, unsigned char *  gray_buffer, unsigned  gray_line_step = 0  ) const

overridevirtual

fills a user given buffer with the gray values, with an optional nearest-neighbor down sampling and an optional subregion

Author

Suat Gedikli

Parameters

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

Implements openni_wrapper::Image.

fillRGB()

void openni_wrapper::ImageRGB24::fillRGB ( unsigned  width, unsigned  height, unsigned char *  rgb_buffer, unsigned  rgb_line_step = 0  ) const

overridevirtual

fills a user given buffer with the RGB values, with an optional nearest-neighbor down sampling and an optional subregion

Author

Suat Gedikli

Parameters

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

Implements openni_wrapper::Image.

getEncoding()

Encoding openni_wrapper::ImageRGB24::getEncoding ( ) const

inlineoverridevirtual

returns the encoding of the native data.

Author

Suat Gedikli

Returns

encoding

Implements openni_wrapper::Image.

Definition at line 63 of file openni_image_rgb24.h.

isResizingSupported()

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

overridevirtual

Author

Suat Gedikli

Parameters

[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

Returns

whether the resizing is supported or not.

Implements openni_wrapper::Image.

resizingSupported()

bool openni_wrapper::ImageRGB24::resizingSupported ( unsigned  input_width, unsigned  input_height, unsigned  output_width, unsigned  output_height  )

inlinestatic

Definition at line 75 of file openni_image_rgb24.h.

---

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

• pcl/io/openni_camera/openni_image_rgb24.h