Point Cloud Library (PCL)  1.9.1
image_rgb24.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011 Willow Garage, Inc.
5  *
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of the copyright holder(s) nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  *
35  */
36 #include <pcl/pcl_config.h>
37 
38 #ifndef PCL_IO_IMAGE_RGB_H_
39 #define PCL_IO_IMAGE_RGB_H_
40 
41 #include <pcl/pcl_macros.h>
42 #include <boost/chrono.hpp>
43 
44 #include <pcl/io/image.h>
45 
46 namespace pcl
47 {
48  namespace io
49  {
50  /**
51  * @brief This class provides methods to fill a RGB or Grayscale image buffer from underlying RGB24 image.
52  * @ingroup io
53  */
54  class PCL_EXPORTS ImageRGB24 : public pcl::io::Image
55  {
56  public:
57 
58  ImageRGB24 (FrameWrapper::Ptr image_metadata);
59  ImageRGB24 (FrameWrapper::Ptr image_metadata, Timestamp timestamp);
60  virtual ~ImageRGB24 () throw ();
61 
62  inline virtual Encoding
63  getEncoding () const
64  {
65  return (RGB);
66  }
67 
68  virtual void
69  fillRGB (unsigned width, unsigned height, unsigned char* rgb_buffer, unsigned rgb_line_step = 0) const;
70 
71  virtual void
72  fillGrayscale (unsigned width, unsigned height, unsigned char* gray_buffer, unsigned gray_line_step = 0) const;
73 
74  virtual bool
75  isResizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const;
76 
77  private:
78 
79  // Struct used for type conversion
80  typedef struct
81  {
82  uint8_t r;
83  uint8_t g;
84  uint8_t b;
85  } RGB888Pixel;
86  };
87 
88  } // namespace
89 }
90 
91 #endif // PCL_IO_IMAGE_RGB_H_
boost::shared_ptr< FrameWrapper > Ptr
This file defines compatibility wrappers for low level I/O functions.
Definition: convolution.h:45
A structure representing RGB color information.
This class provides methods to fill a RGB or Grayscale image buffer from underlying RGB24 image...
Definition: image_rgb24.h:54
Image interface class providing an interface to fill a RGB or Grayscale image buffer.
Definition: image.h:56
virtual Encoding getEncoding() const
returns the encoding of the native data.
Definition: image_rgb24.h:63
boost::chrono::high_resolution_clock::time_point Timestamp
Definition: image.h:63