Point Cloud Library (PCL)  1.14.1-dev
openni_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 
37 #pragma once
38 
39 #include <pcl/pcl_config.h>
40 #include <pcl/memory.h>
41 #ifdef HAVE_OPENNI
42 
43 #include "openni_image.h"
44 #include <pcl/pcl_macros.h>
45 
46 namespace openni_wrapper
47 {
48 
49  /**
50  * @brief This class provides methods to fill a RGB or Grayscale image buffer from underlying RGB24 image.
51  * @author Suat Gedikli
52  * @date 19. June 2011
53  * @ingroup io
54  */
55  class PCL_EXPORTS ImageRGB24 : public Image
56  {
57  public:
58 
59  ImageRGB24 (pcl::shared_ptr<xn::ImageMetaData> image_meta_data) noexcept;
60  ~ImageRGB24 () noexcept override;
61 
62  inline Encoding
63  getEncoding () const override
64  {
65  return (RGB);
66  }
67 
68  void fillRGB (unsigned width, unsigned height, unsigned char* rgb_buffer, unsigned rgb_line_step = 0) const override;
69  void fillGrayscale (unsigned width, unsigned height, unsigned char* gray_buffer, unsigned gray_line_step = 0) const override;
70  bool isResizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const override;
71  inline static bool resizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height);
72  } ;
73 
74  bool
75  ImageRGB24::resizingSupported (unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height)
76  {
77  return (output_width <= input_width && output_height <= input_height && input_width % output_width == 0 && input_height % output_height == 0 );
78  }
79 
80 } // namespace openni_wrapper
81 
82 #endif // HAVE_OPENNI
Image class containing just a reference to image meta data.
Definition: openni_image.h:59
This class provides methods to fill a RGB or Grayscale image buffer from underlying RGB24 image.
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 a...
bool isResizingSupported(unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height) const override
~ImageRGB24() noexcept override
ImageRGB24(pcl::shared_ptr< xn::ImageMetaData > image_meta_data) noexcept
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...
static bool resizingSupported(unsigned input_width, unsigned input_height, unsigned output_width, unsigned output_height)
Defines functions, macros and traits for allocating and using memory.
Defines all the PCL and non-PCL macros used.
#define PCL_EXPORTS
Definition: pcl_macros.h:323