GistEstimator.H

Go to the documentation of this file.

/*!@file Neuro/GistEstimator.H GistEstimator base class */

// //////////////////////////////////////////////////////////////////// //
// The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
// by the University of Southern California (USC) and the iLab at USC.  //
// See http://iLab.usc.edu for information about this project.          //
// //////////////////////////////////////////////////////////////////// //
// Major portions of the iLab Neuromorphic Vision Toolkit are protected //
// under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
// in Visual Environments, and Applications'' by Christof Koch and      //
// Laurent Itti, California Institute of Technology, 2001 (patent       //
// pending; application number 09/912,225 filed July 23, 2001; see      //
// http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
// //////////////////////////////////////////////////////////////////// //
// This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
//                                                                      //
// The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
// redistribute it and/or modify it under the terms of the GNU General  //
// Public License as published by the Free Software Foundation; either  //
// version 2 of the License, or (at your option) any later version.     //
//                                                                      //
// The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
// that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
// implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
// PURPOSE.  See the GNU General Public License for more details.       //
//                                                                      //
// You should have received a copy of the GNU General Public License    //
// along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
// to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
// Boston, MA 02111-1307 USA.                                           //
// //////////////////////////////////////////////////////////////////// //
//
// Primary maintainer for this file: Christian Siagian <siagian@usc.edu>
// $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Neuro/GistEstimator.H $
// $Id: GistEstimator.H 11103 2009-04-13 18:32:38Z lzc $
//

#ifndef NEURO_GISTESTIMATOR_H_DEFINED
#define NEURO_GISTESTIMATOR_H_DEFINED

#include "Component/ModelComponent.H"
#include "Component/ModelParam.H"
#include "Simulation/SimModule.H"
#include "Neuro/NeuroOpts.H"
#include "Neuro/NeuroSimEvents.H"
#include "Neuro/SpatialMetrics.H"
#include "Simulation/SimEvents.H"
#include "Image/Image.H"

class VisualCortex;

//! Abstract base class; see GistEstimatorStd for the standard implementation.
class GistEstimator : public SimModule
{
public:
  //! Constructor
  GistEstimator(OptionManager& mgr,
                const std::string& descrName = "Gist Estimator",
                const std::string& tagName = "gistestimator");

  //! Destructor
  virtual ~GistEstimator();

  //! return the gist feature values
  virtual Image<double> getGist() = 0;
};

// ######################################################################

//! gist save adapter class
class GistEstimatorAdapter : public GistEstimator
{
public:
  //! Constructor
  GistEstimatorAdapter(OptionManager& mgr,
                       const std::string& descrName,
                       const std::string& tagName);
  //! Destructor
  virtual ~GistEstimatorAdapter();

protected:
    //! Callback for every time we should save our outputs
  SIMCALLBACK_DECLARE(GistEstimatorAdapter, SimEventSaveOutput);

  //! Save our internals?
  OModelParam<bool> itsSaveResults;
};

// ######################################################################
/* So things look consistent in everyone's emacs... */
/* Local Variables: */
/* indent-tabs-mode: nil */
/* End: */

#endif // NEURO_GISTESTIMATOR_H_DEFINED