SimulationViewer.H

Go to the documentation of this file.

/*!@file Neuro/SimulationViewer.H visualize various model simulations */

// //////////////////////////////////////////////////////////////////// //
// The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2003   //
// 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: Laurent Itti <itti@usc.edu>
// $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Neuro/SimulationViewer.H $
// $Id: SimulationViewer.H 10825 2009-02-11 07:46:59Z itti $
//

#ifndef SIMULATIONVIEWER_H_DEFINED
#define SIMULATIONVIEWER_H_DEFINED

#include "Component/ModelComponent.H"
#include "Component/ModelParam.H"
#include "Image/Image.H"
#include "Media/MediaSimEvents.H"
#include "Simulation/SimModule.H"

template <class T> class Image;

//! This class provides an abstract interface for a simulation viewer
/*! Its typical usage is with a model that generates shifts of
  attention, eye and head movements. Derivatives from this class will
  handle visualizing those events. See SimulationViewerStd.H for an
  example of such derivative. The base class described here just
  specifies the interface. */
class SimulationViewer : public SimModule {
public:
  // ######################################################################
  /*! @name Constructors and destructors */
  //@{

  //! Constructor. See ModelComponent.H.
    /*! @param mgr our ModelManager (see ModelManager.H)
      @param descrName descriptive name for human usage
      @param tagName name for ParamMap usage */
  SimulationViewer(OptionManager& mgr,
                   const std::string& descrName = "Simulation Viewer",
                   const std::string& tagName = "SimulationViewer");

  //! Destructor
  virtual ~SimulationViewer();

  //@}

protected:
  //! Callback for when a new scene description is available
  SIMCALLBACK_DECLARE(SimulationViewer, SimEventSceneDescription);

  //! Callback for when a new object description is available
  SIMCALLBACK_DECLARE(SimulationViewer, SimEventObjectDescription);

  OModelParam<bool> itsDisplayInterp; //!< use interpolation to display maps?
  OModelParam<float> itsMapFactor; //!< factor to use to display maps
  OModelParam<std::string> itsMapType; //!< type of map to use for displays

  //! Helper function to get the latest ''saliency map''
  /*! What is returned here could be SM, AGM, TRM, VCO, etc in
    normalized or un-normalized form, depending upon the values of
    itsMapFactor and itsMapType. If warn is true an error will be
    displayed if no suitable map is found in the event queue */
  Image<float> getMap(SimEventQueue& q, const bool warn = true) const;
};

#endif

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

---