Point Cloud Library (PCL)  1.14.0-dev
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
openni_wrapper::ImageBayerGRBG Class Reference
Module io

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

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

+ Inheritance diagram for openni_wrapper::ImageBayerGRBG:
+ Collaboration diagram for openni_wrapper::ImageBayerGRBG:

Public Types

enum  DebayeringMethod { Bilinear = 0 , EdgeAware , EdgeAwareWeighted }
 
- 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 >
 

Public Member Functions

 ImageBayerGRBG (pcl::shared_ptr< xn::ImageMetaData > image_meta_data, DebayeringMethod method) noexcept
 
 ~ImageBayerGRBG () noexcept override
 
Encoding getEncoding () const override
 returns the encoding of the native data. More...
 
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 More...
 
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 More...
 
bool isResizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const override
 
void setDebayeringMethod (const DebayeringMethod &method) noexcept
 
DebayeringMethod getDebayeringMethod () const noexcept
 
- Public Member Functions inherited from openni_wrapper::Image
 Image (pcl::shared_ptr< xn::ImageMetaData > image_meta_data) noexcept
 Constructor. More...
 
virtual ~Image () noexcept
 virtual Destructor that never throws an exception. More...
 
void fillRaw (unsigned char *rgb_buffer) const noexcept
 fills a user given buffer with the raw values. More...
 
unsigned getWidth () const noexcept
 
unsigned getHeight () const noexcept
 
unsigned getFrameID () const noexcept
 
unsigned long getTimeStamp () const noexcept
 
const xn::ImageMetaData & getMetaData () const noexcept
 

Static Public Member Functions

static bool resizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height)
 

Protected Attributes

DebayeringMethod debayering_method_
 
- 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 Bayer pattern image.

Author
Suat Gedikli gedik.nosp@m.li@w.nosp@m.illow.nosp@m.gara.nosp@m.ge.co.nosp@m.m

Definition at line 54 of file openni_image_bayer_grbg.h.

Member Enumeration Documentation

◆ DebayeringMethod

enum openni_wrapper::ImageBayerGRBG::DebayeringMethod
Enumerator
Bilinear 
EdgeAware 
EdgeAwareWeighted 

Definition at line 57 of file openni_image_bayer_grbg.h.

Constructor & Destructor Documentation

◆ ImageBayerGRBG()

openni_wrapper::ImageBayerGRBG::ImageBayerGRBG ( pcl::shared_ptr< xn::ImageMetaData >  image_meta_data,
DebayeringMethod  method 
)
noexcept

◆ ~ImageBayerGRBG()

openni_wrapper::ImageBayerGRBG::~ImageBayerGRBG ( )
overridenoexcept

Member Function Documentation

◆ fillGrayscale()

void openni_wrapper::ImageBayerGRBG::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]widthdesired width of output image.
[in]heightdesired height of output image.
[in,out]gray_bufferthe output gray buffer.
[in]gray_line_stepoptional line step in bytes to allow the output in a rectangular subregion of the output buffer.

Implements openni_wrapper::Image.

◆ fillRGB()

void openni_wrapper::ImageBayerGRBG::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]widthdesired width of output image.
[in]heightdesired height of output image.
[in,out]rgb_bufferthe output RGB buffer.
[in]rgb_line_stepoptional line step in bytes to allow the output in a rectangular subregion of the output buffer.

Implements openni_wrapper::Image.

◆ getDebayeringMethod()

ImageBayerGRBG::DebayeringMethod openni_wrapper::ImageBayerGRBG::getDebayeringMethod ( ) const
inlinenoexcept

Definition at line 92 of file openni_image_bayer_grbg.h.

◆ getEncoding()

Encoding openni_wrapper::ImageBayerGRBG::getEncoding ( ) const
inlineoverridevirtual

returns the encoding of the native data.

Author
Suat Gedikli
Returns
encoding

Implements openni_wrapper::Image.

Definition at line 68 of file openni_image_bayer_grbg.h.

◆ isResizingSupported()

bool openni_wrapper::ImageBayerGRBG::isResizingSupported ( unsigned  input_width,
unsigned  input_height,
unsigned  output_width,
unsigned  output_height 
) const
overridevirtual
Author
Suat Gedikli
Parameters
[in]input_widthwidth of input image
[in]input_heightheight of input image
[in]output_widthwidth of desired output image
[in]output_heightheight of desired output image
Returns
whether the resizing is supported or not.

Implements openni_wrapper::Image.

◆ resizingSupported()

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

Definition at line 98 of file openni_image_bayer_grbg.h.

◆ setDebayeringMethod()

void openni_wrapper::ImageBayerGRBG::setDebayeringMethod ( const DebayeringMethod &  method)
inlinenoexcept

Definition at line 86 of file openni_image_bayer_grbg.h.

Member Data Documentation

◆ debayering_method_

DebayeringMethod openni_wrapper::ImageBayerGRBG::debayering_method_
protected

Definition at line 82 of file openni_image_bayer_grbg.h.

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