GistEstimatorConfigurator.H

Go to the documentation of this file.
00001 /*!@file Neuro/GistEstimatorConfigurator.H
00002   future expansions for run-time options                                */
00003 
00004 // //////////////////////////////////////////////////////////////////// //
00005 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2003   //
00006 // by the University of Southern California (USC) and the iLab at USC.  //
00007 // See http://iLab.usc.edu for information about this project.          //
00008 // //////////////////////////////////////////////////////////////////// //
00009 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00010 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00011 // in Visual Environments, and Applications'' by Christof Koch and      //
00012 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00013 // pending; application number 09/912,225 filed July 23, 2001; see      //
00014 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00015 // //////////////////////////////////////////////////////////////////// //
00016 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00017 //                                                                      //
00018 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00019 // redistribute it and/or modify it under the terms of the GNU General  //
00020 // Public License as published by the Free Software Foundation; either  //
00021 // version 2 of the License, or (at your option) any later version.     //
00022 //                                                                      //
00023 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00024 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00025 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00026 // PURPOSE.  See the GNU General Public License for more details.       //
00027 //                                                                      //
00028 // You should have received a copy of the GNU General Public License    //
00029 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00030 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00031 // Boston, MA 02111-1307 USA.                                           //
00032 // //////////////////////////////////////////////////////////////////// //
00033 //
00034 // Primary maintainer for this file: Christian Siagian <siagian@usc.edu>
00035 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Neuro/GistEstimatorConfigurator.H $
00036 // $Id: GistEstimatorConfigurator.H 8160 2007-03-21 21:34:16Z rjpeters $
00037 //
00038 
00039 #ifndef GISTESTIMATORCONFIGURATOR_H_DEFINED
00040 #define GISTESTIMATORCONFIGURATOR_H_DEFINED
00041 
00042 #include "Component/ModelComponent.H"
00043 #include "Component/ModelParam.H"
00044 
00045 class GistEstimator;
00046 
00047 //! GistEstimator configurator
00048 /*! This will export the --ge-type=XX command-line option and will
00049   instantiate a GistEstimator of the desired type as the option gets
00050   assigned a value. As this happens, new options may become available
00051   in the command-line. To see them, use --help AFTER you have chosen
00052   the type to use. The current Gist Estimator may be retrieved using
00053   getGE(). */
00054 class GistEstimatorConfigurator : public ModelComponent
00055 {
00056 public:
00057   //! Constructor
00058   GistEstimatorConfigurator(OptionManager& mgr,
00059                             const std::string& descrName =
00060                             "Gist Estimator Configurator",
00061                             const std::string& tagName =
00062                             "GistEstimatorConfigurator");
00063 
00064   //! destructor
00065   virtual ~GistEstimatorConfigurator();
00066 
00067   //! Get the chosen GistEstimator
00068   /*! You should call this during start() of the ModelComponent that
00069       needs the GistEstimator. NOTE: the result will never be null
00070       (since it's a nub::ref rather than a nub::soft_ref), but the
00071       result might be a "stub" object (e.g. GistEstimatorStub)
00072       designed to gracefully do nothing. */
00073   nub::ref<GistEstimator> getGE() const;
00074 
00075 protected:
00076   OModelParam<std::string> itsGEtype; //!< type of Gist Estimator
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<GistEstimator> itsGE; // the Gist Estimator
00088 };
00089 
00090 #endif
00091 
00092 // ######################################################################
00093 /* So things look consistent in everyone's emacs... */
00094 /* Local Variables: */
00095 /* indent-tabs-mode: nil */
00096 /* End: */
Generated on Sun May 8 08:41:03 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3