VisualCortexConfigurator.H

Go to the documentation of this file.
00001 /*!@file Neuro/VisualCortexConfigurator.H run-time selects which
00002   VisualCoxter to use */
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: Laurent Itti <itti@usc.edu>
00035 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Neuro/VisualCortexConfigurator.H $
00036 // $Id: VisualCortexConfigurator.H 8160 2007-03-21 21:34:16Z rjpeters $
00037 //
00038 
00039 #ifndef VISUALCORTEXCONFIGURATOR_H_DEFINED
00040 #define VISUALCORTEXCONFIGURATOR_H_DEFINED
00041 
00042 #include "Component/ModelComponent.H"
00043 #include "Component/ModelParam.H"
00044 
00045 class VisualCortex;
00046 class Beowulf;
00047 
00048 //! VisualCortex configurator
00049 /*! This will export the --vc-type=XX command-line option and will
00050   instantiate a VisualCortex of the desired type as the option gets
00051   assigned a value. As this happens, new options may become available
00052   in the command-line. To see them, use --help AFTER you have chosen
00053   the type to use. The current VisualCortex may be retrieved using
00054   getVC(). */
00055 class VisualCortexConfigurator : public ModelComponent
00056 {
00057 public:
00058   //! Constructor
00059   VisualCortexConfigurator(OptionManager& mgr,
00060                            const std::string& descrName =
00061                            "Visual Cortex Configurator",
00062                            const std::string& tagName =
00063                            "VisualCortexConfigurator");
00064 
00065   //! destructor
00066   virtual ~VisualCortexConfigurator();
00067 
00068   //! Intercept people changing our ModelParam
00069   /*! See ModelComponent.H; as parsing the command-line or reading a
00070     config file sets our name, we'll also here instantiate a
00071     controller of the proper type (and export its options) */
00072   virtual void paramChanged(ModelParamBase* const param,
00073                             const bool valueChanged,
00074                             ParamClient::ChangeStatus* status);
00075 
00076   //! Get the chosen VisualCortex
00077   /*! You should call this during start() of the ModelComponent that
00078     needs the VisualCortex. CAUTION: this may be a
00079     rutz::shared_ptr(NULL) if no controller has been chosen. */
00080   nub::ref<VisualCortex> getVC() const;
00081 
00082   //! If the chosen VisualCortex uses a Beowulf, get it here
00083   /*! You should call this during start() of the ModelComponent that
00084     needs the VisualCortex. CAUTION: this may be a
00085     rutz::shared_ptr(NULL) if no controller has been chosen. */
00086   nub::soft_ref<Beowulf> getBeo() const;
00087 
00088 protected:
00089   OModelParam<std::string> itsVCtype; //!< type of visual cortex
00090 
00091 private:
00092   nub::ref<VisualCortex> itsVC; // the visual cortex
00093   nub::soft_ref<Beowulf> itsBeo;     // we may also need a Beowulf
00094 };
00095 
00096 #endif
00097 
00098 // ######################################################################
00099 /* So things look consistent in everyone's emacs... */
00100 /* Local Variables: */
00101 /* indent-tabs-mode: nil */
00102 /* End: */
Generated on Sun May 8 08:41:07 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3