OpticalFlowTypes.H

00001 /*!@file Image/OpticalFlowTypes.H Definition of the pyramid types */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2003   //
00005 // by the 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: Laurent Itti <itti@usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Robots/Beobot2/Navigation/FOE_Navigation/OpticalFlowTypes.H $
00035 // $Id: $
00036 //
00037 
00038 #ifndef OPTICALFLOWTYPES_H_DEFINED
00039 #define OPTICALFLOWTYPES_H_DEFINED
00040 
00041 #include <string> // for string conversions
00042 
00043 // ######################################################################
00044 //! Possible types of optical flow algorithms
00045 enum OpticalFlowType {
00046   LucasKanade  = 0, //!< Lucas Kanade optical flow
00047   HornSchunck  = 1, //!< Horn & Schunck optical flow
00048   combo        = 2
00049   // if you add a new type here, also update the names in the function below!
00050 };
00051 
00052 //! number of known OpticalFlowTypes:
00053 #define NBOPTICALFLOWTYPES 3
00054 
00055 inline const char* opticalFlowTypeName(const OpticalFlowType p)
00056 {
00057   static const char n[NBOPTICALFLOWTYPES][14] = {
00058     "LucasKanade", "HornSchunck", "combo"};
00059   return n[int(p)];
00060 }
00061 
00062 
00063 //! OpticalFlowType overload
00064 /*! Format is "name" as defined by pyramidTypeName() in OpticalFlowTypes.H */
00065 std::string convertToString(const OpticalFlowType val);
00066 
00067 //! OpticalFlowType overload
00068 /*! Format is "name" as defined by pyramidTypeName() in OpticalFlowTypes.H */
00069 void convertFromString(const std::string& str, OpticalFlowType& val);
00070 
00071 #endif
00072 
00073 // ######################################################################
00074 /* So things look consistent in everyone's emacs... */
00075 /* Local Variables: */
00076 /* indent-tabs-mode: nil */
00077 /* End: */
Generated on Sun May 8 08:41:18 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3