 Image interface class providing an interface to fill a RGB or Grayscale image buffer. More... #include <pcl/io/image.h>          
  
 Public Types 
enum 

Encoding { BAYER_GRBG, YUV422, RGB }
   
using 

Ptr = shared_ptr< Image >
   
using 

ConstPtr = shared_ptr< const Image >
   
using 

Clock = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock
   
using 

Timestamp = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock8b7c:f320:99b9:690f:4595:cd17:293a:c069time_point
   
 
 Public Member Functions 
 

Image (FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr image_metadata)
   
 

Image (FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr image_metadata, Timestamp time)
   
virtual 

~Image ()
 
 
virtual Destructor that never throws an exception. More...

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

   
virtual Encoding 

getEncoding () const =0
 
 
returns the encoding of the native data. More...

   
virtual void 

fillRaw (unsigned char *rgb_buffer) const
 
 
fills a user given buffer with the raw values. More...

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

   
unsigned 

getWidth () const
   
unsigned 

getHeight () const
   
unsigned 

getFrameID () const
   
st8b7c:f320:99b9:690f:4595:cd17:293a:c069uint64_t 

getTimestamp () const
   

Timestamp 

getSystemTimestamp () const
   
const void * 

getData ()
   
int 

getDataSize () const
   
unsigned 

getStep () const
   
 
 Protected Attributes 

FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr 
wrapper_
   

Timestamp 
timestamp_
    Detailed Description 
Image interface class providing an interface to fill a RGB or Grayscale image buffer.  
Parameters
  
[in]
image_metadata

    Definition at line 56 of file image.h. 
Member Typedef Documentation  Clock     using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Clock = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock   
 Definition at line 62 of file image.h.    ConstPtr     using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069ConstPtr = shared_ptr<const Image>   
 Definition at line 60 of file image.h.    Ptr     using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr = shared_ptr<Image>   
 Definition at line 59 of file image.h.    Timestamp     using pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Timestamp = st8b7c:f320:99b9:690f:4595:cd17:293a:c069chrono8b7c:f320:99b9:690f:4595:cd17:293a:c069high_resolution_clock8b7c:f320:99b9:690f:4595:cd17:293a:c069time_point   
 Definition at line 63 of file image.h.   Member Enumeration Documentation  Encoding     enum pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Encoding
   
  Enumerator


BAYER_GRBG 

 

YUV422 

 

RGB 

  Definition at line 65 of file image.h.   Constructor & Destructor Documentation  Image() [1/2]
        pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Image  ( 
FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr  image_metadata
)      inline    
 Definition at line 72 of file image.h.    Image() [2/2]
        pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069Image  ( 
FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr  
image_metadata,      
Timestamp  
time     ) 
     inline    
 Definition at line 77 of file image.h.    ~Image()        virtual pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069~Image  ( 
)      inlinevirtual    
 virtual Destructor that never throws an exception.  Definition at line 85 of file image.h.   Member Function Documentation  fillGrayscale()        virtual void pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069fillGrayscale  ( 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  
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. 
    Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422.    fillRaw()        virtual void pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069fillRaw  ( unsigned char *  rgb_buffer
)  const     inlinevirtual    
 fills a user given buffer with the raw values.  
Parameters
  
[in,out]
rgb_buffer

    Definition at line 121 of file image.h.    fillRGB()        virtual void pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069fillRGB  ( 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  
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. 
    Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422.    getData()        const void* pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getData  ( 
)      inline    
 Definition at line 188 of file image.h.    getDataSize()        int pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getDataSize  ( 
)  const     inline    
 Definition at line 195 of file image.h.    getEncoding()        virtual Encoding pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getEncoding  ( 
)  const     pure virtual    
 returns the encoding of the native data.  
Returns
encoding 
 Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422.    getFrameID()        unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getFrameID  ( 
)  const     inline    
 
Returns
frame id of the image. 
 
Note
frame ids are ascending, but not necessarily synchronized with other streams 
 Definition at line 160 of file image.h.    getHeight()        unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getHeight  ( 
)  const     inline    
 
Returns
height of the image 
 Definition at line 150 of file image.h.    getStep()        unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getStep  ( 
)  const     inline    
 Definition at line 202 of file image.h.    getSystemTimestamp()        
Timestamp pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getSystemTimestamp  ( 
)  const     inline    
 
Returns
the timestamp of the image 
 
Note
the time value is synchronized with the system time. 
 Definition at line 181 of file image.h.    getTimestamp()        st8b7c:f320:99b9:690f:4595:cd17:293a:c069uint64_t pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getTimestamp  ( 
)  const     inline    
 
Returns
the timestamp of the image 
 
Note
the time value is not synchronized with the system time 
 Definition at line 170 of file image.h.    getWidth()        unsigned pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069getWidth  ( 
)  const     inline    
 
Returns
width of the image 
 Definition at line 141 of file image.h.    isResizingSupported()        virtual bool pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069isResizingSupported  ( unsigned  
input_width,      unsigned  
input_height,      unsigned  
output_width,      unsigned  
output_height     ) 
 const     pure virtual    
 
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. 
 Implemented in pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageRGB24, and pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069ImageYUV422.   Member Data Documentation  timestamp_        
Timestamp pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069timestamp_     protected    
 Definition at line 209 of file image.h.    wrapper_        
FrameWrapper8b7c:f320:99b9:690f:4595:cd17:293a:c069Ptr pcl8b7c:f320:99b9:690f:4595:cd17:293a:c069io8b7c:f320:99b9:690f:4595:cd17:293a:c069Imag8b7c:f320:99b9:690f:4595:cd17:293a:c069wrapper_     protected    
 Definition at line 208 of file image.h.   The documentation for this class was generated from the following file: pcl/io/image.h
  

    © 2009–2012, Willow Garage, Inc.
{'path': 'public/docs/point_cloud_library/classpcl_1_1io_1_1_image.html', 'source': 'DevDocs.IO'}