Map.H

Go to the documentation of this file.
00001 /*!@file Beobot/Map.H abstract (geographical) map class for localization */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 by the //
00005 // University of Southern California (USC) and the iLab at USC.         //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Christian Siagian <siagian@usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Beobot/Map.H $
00035 // $Id: Map.H 9412 2008-03-10 23:10:15Z farhan $
00036 //
00037 
00038 #ifndef BEOBOT_MAP_H_DEFINED
00039 #define BEOBOT_MAP_H_DEFINED
00040 
00041 #include "Image/Image.H"
00042 #include "Image/Pixels.H"
00043 
00044 //! Abstract base (2D) map class;
00045 //! see TopologicalMap for the standard implementation.
00046 class Map
00047 {
00048 public:
00049 
00050   //! Constructor: generate a blank map
00051   Map();
00052 
00053   //! Constructor: retrieve the map from a file
00054   Map(std::string fileName);
00055 
00056   //! Destructor
00057   virtual ~Map();
00058 
00059   //! read a map from a file
00060   virtual bool read(std::string fileName) = 0;
00061 
00062   //! write a map to a file
00063   virtual bool write(std::string fileName) = 0;
00064 
00065   //! returns an image representation of the map
00066   virtual Image<PixRGB<byte> > getMapImage(uint w, uint h) = 0;
00067 
00068   //! different maps will have different ways
00069   //! to generate a path
00070   //! so, there's no set function
00071   // virtual std::vector<Point2D<int> > getPath(Point2D<int> a, Point2D<int> b);
00072 
00073   //! edits are implementation specific
00074   //! between map translation should not be done by a class function
00075 };
00076 
00077 #endif // BEOBOT_MAP_H_DEFINED
00078 
00079 // ######################################################################
00080 /* So things look consistent in everyone's emacs... */
00081 /* Local Variables: */
00082 /* indent-tabs-mode: nil */
00083 /* End: */
Generated on Sun May 8 08:40:12 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3