psycho-recall.C

Go to the documentation of this file.

/*!@file AppPsycho/psycho-recall.C Test recall for objects in scenes */

// //////////////////////////////////////////////////////////////////// //
// The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 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/AppPsycho/psycho-recall.C $
// $Id: psycho-recall.C 9412 2008-03-10 23:10:15Z farhan $
//

#include "Component/ModelManager.H"
#include "Component/EventLog.H"
#include "Image/Image.H"
#include "Image/CutPaste.H"
#include "Image/DrawOps.H"
#include "Image/ImageSet.H"
#include "Image/ShapeOps.H"
#include "Psycho/PsychoDisplay.H"
#include "Psycho/EyeTrackerConfigurator.H"
#include "Psycho/EyeTracker.H"
#include "Psycho/PsychoOpts.H"
#include "Component/ComponentOpts.H"
#include "GUI/GUIOpts.H"
#include "Raster/Raster.H"
#include "Util/Types.H"
#include "Util/StringUtil.H"
#include "Util/MathFunctions.H"
#include <fstream>

//! Test recall for objects in scenes
/*! This shows an image to be inspected under eye-tracking. Then a
  series of objects. For each object, the user makes a decision as to
  whether it was in the scene or not. Input file format should be:

  image1.png obj1.png obj2.png ... objN.png
  image2.png obj1.png ... objK.png
  ...

*/

// ######################################################################
static int submain(const int argc, char** argv)
{
  MYLOGVERB = LOG_INFO;  // suppress debug messages

  // Instantiate a ModelManager:
  ModelManager manager("Psychophysics Recall");

  // Instantiate our various ModelComponents:
  nub::soft_ref<EventLog> el(new EventLog(manager));
  manager.addSubComponent(el);

  nub::soft_ref<EyeTrackerConfigurator>
    etc(new EyeTrackerConfigurator(manager));
  manager.addSubComponent(etc);

  nub::soft_ref<PsychoDisplay> d(new PsychoDisplay(manager));
  manager.addSubComponent(d);

  // set a default display size:
  manager.exportOptions(MC_RECURSE);
  manager.setOptionValString(&OPT_SDLdisplayDims, "1920x1080");
  manager.setOptionValString(&OPT_EventLogFileName, "psychodata.psy");
  manager.setOptionValString(&OPT_EyeTrackerType, "ISCAN");

  // Parse command-line:
  if (manager.parseCommandLine(argc, argv, "<fileList>", 1, -1) == false)
    return(1);

  // hook our various babies up and do post-command-line configs:
  nub::soft_ref<EyeTracker> et = etc->getET();
  d->setEyeTracker(et);
  d->setEventLog(el);
  et->setEventLog(el);
  initRandomNumbers();

  // let's get all our ModelComponent instances started:
  manager.start();

  // get the list of images
  std::ifstream file(manager.getExtraArg(0).c_str());
  if (file == 0) LFATAL("Couldn't open file: '%s'",
                        manager.getExtraArg(0).c_str());

  // load up all the image descriptions:
  std::string line;
  std::vector<std::string> lines;
  while(getline(file, line)) lines.push_back(line);

  // create a randomized index:
  uint *idx = new uint[lines.size()];
  for (uint i = 0; i < lines.size(); i ++) idx[i] = i;
  randShuffle(idx, lines.size());
  LINFO("Randomized %"ZU" trials.", lines.size());

  // let's display an ISCAN calibration grid:
  d->clearScreen();
  d->displayISCANcalib();
  d->waitForKey();

  // let's do an eye tracker calibration:
  d->displayText("<SPACE> to calibrate; other key to skip");
  int c = d->waitForKey();
  if (c == ' ') d->displayEyeTrackerCalibration();
  d->clearScreen();
  d->displayText("<SPACE> To Begin Experiment");
  c = d->waitForKey();


  for (uint ii = 0; ii < lines.size(); ++ii)
    {
      std::vector<std::string> tokens;
      split(lines[idx[ii]], " \t", std::back_inserter(tokens));
      if (tokens.size() < 2)
        LFATAL("Need at least one image and one object per line: %s",
               lines[idx[ii]].c_str());

      // pick a random display order for the objects:
      uint *ii = new uint[tokens.size()-1];
      for (uint i = 0; i < tokens.size()-1; ++i) ii[i] = i+1;
      randShuffle(ii, tokens.size()-1);


      // load up the two image and show a fixation cross on a blank screen:
      d->clearScreen();
      LINFO("Loading '%s'...", tokens[0].c_str());
      Image< PixRGB<byte> > ima = Raster::ReadRGB(tokens[0]);

      ImageSet< PixRGB<byte> > objects;
      for (uint i = 0; i < tokens.size()-1; ++i)
        {
          LINFO("Loading object %u/%"ZU": %s", i+1,
                tokens.size()-1, tokens[i].c_str());
          Image< PixRGB<byte> > obj = Raster::ReadRGB(tokens[ii[i]]);
          objects.push_back(obj);
        }

      // Prepare to display the image, and a random mask:
      Image< PixRGB<byte> > image(d->getDims(), NO_INIT);
      inplaceEmbed(image, ima, Rectangle(Point2D<int>(0, 0), image.getDims()),
                   d->getGrey(), true);
      SDL_Surface *surf = d->makeBlittableSurface(image, true);

      Image< PixRGB<byte> > mask(d->getWidth()/8, d->getHeight()/8, NO_INIT);
      for (int i = 0; i < mask.getSize(); i ++)
        mask.setVal(i, PixRGB<byte>(byte(randomUpToNotIncluding(256)),
                                    byte(randomUpToNotIncluding(256)),
                                    byte(randomUpToNotIncluding(256))));
      mask = zoomXY(mask, 8, 8);
      SDL_Surface *msurf = d->makeBlittableSurface(mask, true);
      LINFO("%s ready.", tokens[0].c_str());

      // ready to go whenever the user is ready:
      d->displayFixation();
      d->waitForKey();
      d->pushEvent(std::string("===== Showing image: ") +
                   tokens[0] + " =====");

      // start the eye tracker:
      et->track(true);

      // blink the fixation:
      d->displayFixationBlink();

      // show the image:
      d->displaySurface(surf, -2);

      // fixed presentation time:
      usleep(2000000);

      // Display mask:
      d->displaySurface(msurf, -2);
      usleep(150000);

      // make sure display if off before we stop the tracker:
      d->clearScreen();

      // stop the eye tracker:
      usleep(50000);
      et->track(false);
      SDL_FreeSurface(surf);
      SDL_FreeSurface(msurf);

      // Allow the user to mark some objects:
      for (uint i = 0; i < tokens.size()-1; ++i)
        {
          // create an image with the object:
          Image< PixRGB<byte> > obj(d->getDims(), NO_INIT);
          obj.clear(d->getGrey());
          inplacePaste(obj, objects[i],
                       Point2D<int>((d->getWidth() - objects[i].getWidth())/2,
                               (d->getHeight() - objects[i].getHeight())/2));
          // show the object:
          SDL_Surface *surf2 = d->makeBlittableSurface(obj, true);
          d->displaySurface(surf2, -2);

          int c = d->waitForKey();
          d->pushEvent(sformat("===== Object %s / %u: '%c' (%d) =====",
                               tokens[ii[i]].c_str(), i, c, c));
          SDL_FreeSurface(surf2);
        }

      // get ready for next one or end:
      d->clearScreen();
      delete [] ii;
    }

  d->clearScreen();
  d->displayText("Experiment complete. Thank you!");
  d->waitForKey();

  // stop all our ModelComponents
  manager.stop();

  delete [] idx;

  // all done!
  return 0;
}

// ######################################################################
extern "C" int main(const int argc, char** argv)
{
  // simple wrapper around submain() to catch exceptions (because we
  // want to allow PsychoDisplay to shut down cleanly; otherwise if we
  // abort while SDL is in fullscreen mode, the X server won't return
  // to its original resolution)
  try
    {
      return submain(argc, argv);
    }
  catch (...)
    {
      REPORT_CURRENT_EXCEPTION;
    }

  return 1;
}

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