LoPointTypes.H

Go to the documentation of this file.
00001 /**
00002    \file  Robots/LoBot/metlog/LoPointTypes.H
00003    \brief Various useful types used in several different modules of lomet
00004    data analysis program.
00005 */
00006 
00007 // //////////////////////////////////////////////////////////////////// //
00008 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00009 // by the University of Southern California (USC) and the iLab at USC.  //
00010 // See http://iLab.usc.edu for information about this project.          //
00011 // //////////////////////////////////////////////////////////////////// //
00012 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00013 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00014 // in Visual Environments, and Applications'' by Christof Koch and      //
00015 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00016 // pending; application number 09/912,225 filed July 23, 2001; see      //
00017 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00018 // //////////////////////////////////////////////////////////////////// //
00019 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00020 //                                                                      //
00021 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00022 // redistribute it and/or modify it under the terms of the GNU General  //
00023 // Public License as published by the Free Software Foundation; either  //
00024 // version 2 of the License, or (at your option) any later version.     //
00025 //                                                                      //
00026 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00027 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00028 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00029 // PURPOSE.  See the GNU General Public License for more details.       //
00030 //                                                                      //
00031 // You should have received a copy of the GNU General Public License    //
00032 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00033 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00034 // Boston, MA 02111-1307 USA.                                           //
00035 // //////////////////////////////////////////////////////////////////// //
00036 //
00037 // Primary maintainer for this file: mviswana usc edu
00038 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Robots/LoBot/metlog/LoPointTypes.H $
00039 // $Id: LoPointTypes.H 13934 2010-09-14 23:17:01Z mviswana $
00040 //
00041 
00042 #ifndef LOBOT_POINT_TYPES_DOT_H
00043 #define LOBOT_POINT_TYPES_DOT_H
00044 
00045 //------------------------------ HEADERS --------------------------------
00046 
00047 // Standard C++ headers
00048 #include <utility>
00049 
00050 //----------------------------- NAMESPACE -------------------------------
00051 
00052 namespace lobot {
00053 
00054 //--------------------------- ENUMERATIONS ------------------------------
00055 
00056 /// To gauge lobot's performance, we built an enclosure containing a
00057 /// slalom course. The robot had to start at an initial position and work
00058 /// its way to a goal location. As the robot moved through this obstacle
00059 /// course, it logged a variety of information.
00060 ///
00061 /// When we are analyzing these logs, we sift the information into
00062 /// different lists. For example, one list holds the locations at which
00063 /// the robot's obstacle avoidance algorithms failed and caused it to
00064 /// bump into obstacles; another holds the locations where the robot's
00065 /// emergency stop behaviour was activated; so on an so forth.
00066 ///
00067 /// This enumeration lists the names of the different point lists.
00068 enum PointListName {
00069    TRAJECTORY,
00070    EMERGENCY_STOP,
00071    EXTRICATE,
00072    LGMD_EXTRICATE,
00073    BUMP,
00074 } ;
00075 
00076 /// As its name suggests, a point list is container for several points.
00077 /// For the lomet Robolocust metrics log data analysis program, points
00078 /// are simply pairs of integers. Because lomet is a quick-and-dirty,
00079 /// throwaway sort of program, we are not particularly interested
00080 /// building robust and generally applicable abstractions. Thus, we
00081 /// simply use an STL pair to represent lomet-related points.
00082 ///
00083 /// DEVNOTE: misc/LoTypes.H also defines a type Point. To prevent
00084 /// conflicts, we name this point type mPoint, where the 'm' prefix
00085 /// stands for "lomet".
00086 typedef std::pair<int, int> mPoint ;
00087 
00088 //-----------------------------------------------------------------------
00089 
00090 } // end of namespace encapsulating this file's definitions
00091 
00092 #endif
00093 
00094 /* So things look consistent in everyone's emacs... */
00095 /* Local Variables: */
00096 /* indent-tabs-mode: nil */
00097 /* End: */
Generated on Sun May 8 08:41:31 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3