00001 /*!@file Neuro/SaccadeControllerConfigurator.H Pick a saccade controller */ 00002 00003 // //////////////////////////////////////////////////////////////////// // 00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005 // 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/Neuro/SaccadeControllerConfigurator.H $ 00035 // $Id: SaccadeControllerConfigurator.H 8160 2007-03-21 21:34:16Z rjpeters $ 00036 // 00037 00038 #ifndef NEURO_SACCADECONTROLLERCONFIGURATOR_H_DEFINED 00039 #define NEURO_SACCADECONTROLLERCONFIGURATOR_H_DEFINED 00040 00041 #include "Component/ModelComponent.H" 00042 #include "Component/ModelParam.H" 00043 class SaccadeController; 00044 00045 // ###################################################################### 00046 //! SaccadeController configurator for eye 00047 /*! This will export the --esc-type=XX command-line option and will 00048 instantiate a SaccadeController of the desired type as the option 00049 gets assigned a value. As this happens, new options may become 00050 available in the command-line. To see them, use --help AFTER you 00051 have chosen the name of the controller to use. The current 00052 eye SaccadeController may be retrieved using getSC(). */ 00053 class SaccadeControllerEyeConfigurator : public ModelComponent 00054 { 00055 public: 00056 //! Constructor 00057 SaccadeControllerEyeConfigurator(OptionManager& mgr, 00058 const std::string& descrName = 00059 "Saccade Controller Eye Configurator", 00060 const std::string& tagName = 00061 "SaccadeControllerEyeConfigurator"); 00062 00063 //! destructor 00064 virtual ~SaccadeControllerEyeConfigurator(); 00065 00066 //! Get the chosen SaccadeController 00067 /*! You should call this during start() of the ModelComponent that 00068 needs the SaccadeController. CAUTION: this may be a 00069 rutz::shared_ptr(NULL) if no controller has been chosen. */ 00070 nub::ref<SaccadeController> getSC() const; 00071 00072 //! Intercept people changing our itsSacCtrlName ModelParam 00073 /*! See ModelComponent.H; as parsing the command-line or reading a 00074 config file sets our name, we'll also here instantiate a 00075 controller of the proper type (and export its options) */ 00076 virtual void paramChanged(ModelParamBase* const param, 00077 const bool valueChanged, 00078 ParamClient::ChangeStatus* status); 00079 00080 protected: 00081 OModelParam<std::string> itsSacCtrlType; //!< Type of the controller 00082 00083 private: 00084 nub::ref<SaccadeController> itsSC; // the controller 00085 }; 00086 00087 // ###################################################################### 00088 //! SaccadeController configurator for head 00089 /*! This will export the --hsc-type=XX command-line option and will 00090 instantiate a SaccadeController of the desired type as the option 00091 gets assigned a value. As this happens, new options may become 00092 available in the command-line. To see them, use --help AFTER you 00093 have chosen the name of the controller to use. The current 00094 head SaccadeController may be retrieved using getSC(). */ 00095 class SaccadeControllerHeadConfigurator : public ModelComponent 00096 { 00097 public: 00098 //! Constructor 00099 SaccadeControllerHeadConfigurator(OptionManager& mgr, 00100 const std::string& descrName = 00101 "Saccade Controller Head Configurator", 00102 const std::string& tagName = 00103 "SaccadeControllerHeadConfigurator"); 00104 00105 //! destructor 00106 virtual ~SaccadeControllerHeadConfigurator(); 00107 00108 //! Get the chosen SaccadeController 00109 /*! You should call this during start() of the ModelComponent that 00110 needs the SaccadeController. CAUTION: this may be a 00111 rutz::shared_ptr(NULL) if no controller has been chosen. */ 00112 nub::ref<SaccadeController> getSC() const; 00113 00114 //! Intercept people changing our itsSacCtrlName ModelParam 00115 /*! See ModelComponent.H; as parsing the command-line or reading a 00116 config file sets our name, we'll also here instantiate a 00117 controller of the proper type (and export its options) */ 00118 virtual void paramChanged(ModelParamBase* const param, 00119 const bool valueChanged, 00120 ParamClient::ChangeStatus* status); 00121 00122 protected: 00123 OModelParam<std::string> itsSacCtrlType; //!< Type of the controller 00124 00125 private: 00126 nub::ref<SaccadeController> itsSC; // the controller 00127 }; 00128 00129 00130 00131 // ###################################################################### 00132 /* So things look consistent in everyone's emacs... */ 00133 /* Local Variables: */ 00134 /* mode: c++ */ 00135 /* indent-tabs-mode: nil */ 00136 /* End: */ 00137 00138 #endif // NEURO_SACCADECONTROLLERCONFIGURATOR_H_DEFINED
1.6.3