FovealTransformModule.H

Go to the documentation of this file.
00001 /*!@file SpaceVariant/FovealTransformModule.H a model component that embodies a foveal image transforms. */
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: David J. Berg <dberg@usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu:/software/invt/trunk/saliency/src/SpaceVariant/FovealTransformModule.H $
00035 
00036 #ifndef FOVEALTRANSFORMMODULE_H_DEFINED
00037 #define FOVEALTRANSFORMMODULE_H_DEFINED
00038 
00039 #include "SpaceVariant/SpaceVariantModule.H"
00040 #include "Psycho/PixPerDeg.H"
00041 
00042 // ###################################################################### 
00043 // a Model Component that embodies a foveal transform. See
00044 // Image/SpaceVariantTransforms.H for details on the computation. 
00045 // ######################################################################
00046 class FovealTransformModule : public SpaceVariantModule
00047 {
00048 public:
00049   //! Constructor
00050   /*! See ModelComponent.H for details */
00051   FovealTransformModule(OptionManager& mgr, const std::string& descrName = "FovealTransform Module",
00052                         const std::string& tagName = "FovealTransformModule");
00053 
00054   //! Destructor
00055   virtual ~FovealTransformModule();
00056   
00057   //! reset transforms to the desired input image size
00058   virtual void clear(const Dims& inp_dims);
00059 
00060   /*! separate the foveal and peripherial region  */
00061   template <class T_or_RGB>
00062   void getFoveaPeriphery(const Image<T_or_RGB>& ret_image, 
00063                          Image<T_or_RGB>& fovea, Image<T_or_RGB>& periphery);
00064 
00065   //!get the dims from the command line
00066   Dims getSVDims() const;
00067   
00068 protected:
00069   OModelParam<std::string> itsSvScale;//scale type
00070   OModelParam<float> itsSvFovea; //fovea size
00071   OModelParam<float> itsSvSfac; //compression factor if scale is NONE
00072   OModelParam<float> itsSvBeta; //offset of log
00073   OModelParam<float> itsSvGain; //rf scaling factor
00074   OModelParam<float> itsSvExponent; //rf vs eccentricty steapnes
00075   OModelParam<float> itsSvOffset; //offset of rf size with eccentircity 
00076   OModelParam<float> itsFoveaCutoff;//value of du/dr to consider fovea
00077   OModelParam<Dims> itsSvDims; //dims of transform
00078   OModelParam<PixPerDeg> itsPPD;//pixels per degree
00079 
00080   OModelParam<LevelSpec> itsLevelSpec; //get size of sm for inverse mapping
00081 };
00082 
00083 #endif //FOVEALTRANSFORMMODULE
00084 // ######################################################################
00085 /* So things look consistent in everyone's emacs... */
00086 /* Local Variables: */
00087 /* indent-tabs-mode: nil */
00088 /* End: */
Generated on Sun May 8 08:06:50 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3