photo_image.hpp
Go to the documentation of this file.
00001 /*********************************************************************
00002  *
00003  * Software License Agreement (BSD License)
00004  *
00005  *  Copyright (c) 2012, Robert Bosch LLC.
00006  *  All rights reserved.
00007  *
00008  *  Redistribution and use in source and binary forms, with or without
00009  *  modification, are permitted provided that the following conditions
00010  *  are met:
00011  *
00012  *   * Redistributions of source code must retain the above copyright
00013  *     notice, this list of conditions and the following disclaimer.
00014  *   * Redistributions in binary form must reproduce the above
00015  *     copyright notice, this list of conditions and the following
00016  *     disclaimer in the documentation and/or other materials provided
00017  *     with the distribution.
00018  *   * Neither the name of the Robert Bosch nor the names of its
00019  *     contributors may be used to endorse or promote products derived
00020  *     from this software without specific prior written permission.
00021  *
00022  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00025  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00026  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00027  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00028  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00029  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00032  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00033  *  POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  *********************************************************************/
00036 #ifndef __PHOTO_IMAGE__
00037 #define __PHOTO_IMAGE__
00038 
00039 
00040 class photo_image
00041 {
00042 
00043 private:
00044   int width_;
00045   int height_;
00046   size_t bytes_per_pixel_;
00047   size_t image_size_;
00048   char* data_;
00049 
00050 public:
00051 
00052   photo_image( void );
00053   ~photo_image( void );
00054 
00055 
00056   int getWidth( void );
00057   int getHeight( void );
00058   size_t getBytesPerPixel( void );
00059   size_t getImageSize( void );
00060   char* getDataAddress( void );
00061 
00062   //* sets size and allocates memory for image data
00063   void photo_image_set_size( int image_width, int image_height, size_t image_bytes_per_pixel );
00064 
00065   //* Read an image from filesystem
00066   /*
00067    * This function is a debugging function for use replacing photo_image acquisition using a photo_camera.
00068    * It can only read 24-bit RGB images via OpenCV. It may be extended to handle grayscale and alpha channels in the future.
00069    */
00070   bool photo_image_read( std::string filename );
00071 
00072   //* Write a photo_image to filesystem
00073   /*
00074    * This function is a debugging function for use replacing photo_image acquisition using a photo_camera.
00075    * It can only write 24-bit RGB images via OpenCV. It may be extended to handle grayscale and alpha channels in the future.
00076    */
00077   bool photo_image_write( std::string filename );
00078 };
00079 
00080 #endif // __PHOTO_IMAGE__


photo
Author(s): Benjamin Pitzer
autogenerated on Sat Dec 28 2013 16:48:54