00001 /*!@file Neuro/SaliencyMapConfigurator.H SaliencyMap configurator (factory) for the --sm-type command-line option */ 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/SaliencyMapConfigurator.H $ 00035 // $Id: SaliencyMapConfigurator.H 8160 2007-03-21 21:34:16Z rjpeters $ 00036 // 00037 00038 #ifndef NEURO_SALIENCYMAPCONFIGURATOR_H_DEFINED 00039 #define NEURO_SALIENCYMAPCONFIGURATOR_H_DEFINED 00040 00041 #include "Component/ModelComponent.H" 00042 #include "Component/ModelParam.H" 00043 #include "nub/ref.h" 00044 00045 class SaliencyMap; 00046 00047 // ###################################################################### 00048 //! SaliencyMap configurator 00049 // ###################################################################### 00050 /*! This will export the --sm-type=XX command-line option and will 00051 instantiate an SM of the desired type as the option gets assigned a 00052 value. As this happens, new options may become available in the 00053 command-line. To see them, use --help AFTER you have chosen the type 00054 to use. The current SM may be retrieved using getSM(). */ 00055 class SaliencyMapConfigurator : public ModelComponent 00056 { 00057 public: 00058 //! Constructor 00059 SaliencyMapConfigurator(OptionManager& mgr, 00060 const std::string& descrName = 00061 "Saliency Map Configurator", 00062 const std::string& tagName = 00063 "SaliencyMapConfigurator"); 00064 00065 //! destructor 00066 virtual ~SaliencyMapConfigurator(); 00067 00068 //! Get the chosen SM 00069 /*! You should call this during start() of the ModelComponent that 00070 needs the SM. NOTE: this will never return a null pointer (since 00071 it's a nub::ref rather than a nub::soft_ref), but it may return 00072 a "stub" object (e.g. SaliencyMapStub). */ 00073 nub::ref<SaliencyMap> getSM() const; 00074 00075 protected: 00076 OModelParam<std::string> itsSMtype; //!< type of saliency map 00077 00078 //! Intercept people changing our ModelParam 00079 /*! See ModelComponent.H; as parsing the command-line or reading a 00080 config file sets our name, we'll also here instantiate a 00081 controller of the proper type (and export its options) */ 00082 virtual void paramChanged(ModelParamBase* const param, 00083 const bool valueChanged, 00084 ParamClient::ChangeStatus* status); 00085 00086 private: 00087 nub::ref<SaliencyMap> itsSM; // the saliency map 00088 }; 00089 00090 // ###################################################################### 00091 /* So things look consistent in everyone's emacs... */ 00092 /* Local Variables: */ 00093 /* mode: c++ */ 00094 /* indent-tabs-mode: nil */ 00095 /* End: */ 00096 00097 #endif // NEURO_SALIENCYMAPCONFIGURATOR_H_DEFINED
1.6.3