ChannelMaps.H

Go to the documentation of this file.
00001 /*!@file Channels/ChannelMaps.H Classes to hold maps from a Channel hierarchy */
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/Channels/ChannelMaps.H $
00035 // $Id: ChannelMaps.H 12574 2010-01-15 02:09:17Z itti $
00036 //
00037 
00038 #ifndef CHANNELS_CHANNELMAPS_H_DEFINED
00039 #define CHANNELS_CHANNELMAPS_H_DEFINED
00040 
00041 #include "Image/NamedImage.H"
00042 #include "Image/ImageSet.H"
00043 class ChannelBase;
00044 class EnvVisualCortexFloat;
00045 
00046 //######################################################################
00047 //! ChannelMaps hold maps from a channel hierarchy
00048 /*! These classes are used to take a copy of all the maps in a Channel
00049     hierarchy. Note that simply summing all the maps will not give
00050     rise to a saliency map, as some weighing and non-linear operations
00051     will be missing. The purpose here is to allow the maps to be
00052     transported to various places, e.g., through a SimReq
00053     mechanism. */
00054 class ChannelMaps {
00055 public:
00056   //! Constructor
00057   ChannelMaps(ChannelBase* chan, const std::string& prefix = "");
00058 
00059   //! Constructor
00060   ChannelMaps(EnvVisualCortexFloat* vcx, const std::string& prefix = "");
00061 
00062   //! Constructor with just an output map and no subchans/submaps
00063   ChannelMaps(const NamedImage<float>& outmap);
00064 
00065   //! Destructor
00066   ~ChannelMaps();
00067 
00068   //! Get the output map
00069   const NamedImage<float>& getMap() const;
00070 
00071   //! number of subchannels, non-zero if complex, zero if single
00072   uint numSubchans() const;
00073 
00074   //! access to the subchannels
00075   rutz::shared_ptr<ChannelMaps> subChanMaps(const uint idx) const;
00076 
00077   //! Return the number of feature maps represented by this channel and its subchans
00078   uint numSubmaps() const;
00079 
00080   //! Get the feature map at the given index, linearizing the channel hierarchy
00081   const NamedImage<float>& getSubmap(const uint index) const;
00082 
00083   //! get raw CS map, linearizing the channel hierarchy
00084   const NamedImage<float>& getRawCSmap(const uint idx) const;
00085 
00086   //! do we have a raw image pyramid?
00087   bool hasPyramid() const;
00088 
00089   //! get access to our raw pyramid
00090   const ImageSet<float>& getPyramid() const;
00091 
00092 private:
00093   NamedImage<float> itsOutputMap;
00094 
00095   std::vector< NamedImage<float> > itsSubmaps;
00096   std::vector< NamedImage<float> > itsRawCSmaps;
00097   ImageSet<float> itsPyramid;
00098 
00099   std::vector< rutz::shared_ptr<ChannelMaps> > itsSubchanMaps;
00100 
00101   void lookupSubmap(const uint idx, uint& subchan, uint& subidx) const;
00102 
00103   ChannelMaps(const ChannelMaps&); // not allowed
00104   ChannelMaps& operator=(const ChannelMaps&); // not allowed
00105 };
00106 
00107 // ######################################################################
00108 /* So things look consistent in everyone's emacs... */
00109 /* Local Variables: */
00110 /* mode: c++ */
00111 /* indent-tabs-mode: nil */
00112 /* End: */
00113 
00114 #endif // CHANNELS_CHANNELMAPS_H_DEFINED
Generated on Sun May 8 08:40:21 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3