Point Cloud Library (PCL)  1.7.0
/tmp/buildd/pcl-1.7-1.7.0/recognition/include/pcl/recognition/region_xy.h
00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Point Cloud Library (PCL) - www.pointclouds.org
00005  *  Copyright (c) 2010-2011, Willow Garage, Inc.
00006  *
00007  *  All rights reserved. 
00008  *
00009  *  Redistribution and use in source and binary forms, with or without
00010  *  modification, are permitted provided that the following conditions
00011  *  are met:
00012  *
00013  *   * Redistributions of source code must retain the above copyright
00014  *     notice, this list of conditions and the following disclaimer.
00015  *   * Redistributions in binary form must reproduce the above
00016  *     copyright notice, this list of conditions and the following
00017  *     disclaimer in the documentation and/or other materials provided
00018  *     with the distribution.
00019  *   * Neither the name of Willow Garage, Inc. nor the names of its
00020  *     contributors may be used to endorse or promote products derived
00021  *     from this software without specific prior written permission.
00022  *
00023  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00024  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00025  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00026  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00027  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00028  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00029  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00030  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00032  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00033  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00034  *  POSSIBILITY OF SUCH DAMAGE.
00035  *
00036  */
00037 
00038 #ifndef PCL_FEATURES_REGION_XY_
00039 #define PCL_FEATURES_REGION_XY_
00040 
00041 #include <fstream>
00042 
00043 namespace pcl
00044 {
00045   /** \brief Function for reading data from a stream. */
00046   template <class Type>
00047   void read (std::istream & stream, Type & value)
00048   {
00049     stream.read (reinterpret_cast<char*> (&value), sizeof(value));
00050   }
00051 
00052   /** \brief Function for reading data arrays from a stream. */
00053   template <class Type>
00054   void read (std::istream & stream, Type * value, int nr_values)
00055   {
00056     for (int value_index = 0; value_index < nr_values; ++value_index)
00057     {
00058       read (stream, value[value_index]);
00059     }
00060   }
00061 
00062   /** \brief Function for writing data to a stream. */
00063   template <class Type>
00064   void write (std::ostream & stream, Type value)
00065   {
00066     stream.write (reinterpret_cast<char*> (&value), sizeof (value));
00067   }
00068 
00069   /** \brief Function for writing data arrays to a stream. */
00070   template <class Type>
00071   void write (std::ostream & stream, Type * value, int nr_values)
00072   {
00073     for (int value_index = 0; value_index < nr_values; ++value_index)
00074     {
00075       write (stream, value[value_index]);
00076     }
00077   }
00078 
00079   /** \brief Defines a region in XY-space.
00080     * \author Stefan Holzer
00081     */
00082   struct PCL_EXPORTS RegionXY
00083   {
00084     /** \brief Constructor. */
00085     RegionXY () : x (0), y (0), width (0), height (0) {}
00086 
00087     /** \brief x-position of the region. */
00088     int x;
00089     /** \brief y-position of the region. */
00090     int y;
00091     /** \brief width of the region. */
00092     int width;
00093     /** \brief height of the region. */
00094     int height;
00095 
00096     /** \brief Serializes the object to the specified stream.
00097       * \param[out] stream the stream the object will be serialized to. */
00098     void
00099     serialize (std::ostream & stream) const
00100     {
00101       write (stream, x);
00102       write (stream, y);
00103       write (stream, width);
00104       write (stream, height);
00105     }
00106 
00107     /** \brief Deserializes the object from the specified stream.
00108       * \param[in] stream the stream the object will be deserialized from. */
00109     void 
00110     deserialize (::std::istream & stream)
00111     {
00112       read (stream, x);
00113       read (stream, y);
00114       read (stream, width);
00115       read (stream, height);
00116     }
00117 
00118   };
00119 }
00120 
00121 #endif // PCL_FEATURES_REGION_XY_