StructurePlot.H

Go to the documentation of this file.

/*!@file ModelNeuron/StructurePlot.H Class declaration for StructurePlot
   which creates hierarchical 2d image represenation of a structures
   activity*/

// //////////////////////////////////////////////////////////////////// //
// 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: David J. Berg <dberg@usc.edu>
// $HeadURL:svn://ilab.usc.edu/trunk/saliency/src/ModelNeuron/StructurePlot.H$

#ifndef MODELNEURON_STRUCTUREPLOT_H_DEFINED
#define MODELNEURON_STRUCTUREPLOT_H_DEFINED

#include "Image/Layout.H"
#include "Image/Image.H"
#include "Image/Pixels.H"
#include "Image/DrawOps.H"
#include "Image/ShapeOps.H"
#include "Image/MathOps.H"
#include "Image/Range.H"
#include "Util/StringConversions.H"

#include "ModelNeuron/LayerDecoder.H"
#include "ModelNeuron/Location.H"
#include "ModelNeuron/PlotBuffer.H"

class StructureModule;
// ######################################################################
// ! A class for displaying a hierarchy of activity from a
// StructureModule's sub units.
// ######################################################################
enum NormalizeType {SCALE, RANGE, SET_RANGE};

class StructurePlot
{
public:
  //!Constructor 
  StructurePlot(const StructureModule& structure,
                const NeuralDecoder& decoder, 
                const NormalizeType normtype = SCALE, 
                const double& rangemin = 0, const double& rangemax = 0);

  //!Constructor 
  StructurePlot(const StructureModule& structure,
                const NormalizeType normtype = SCALE, 
                const double& rangemin = 0, const double& rangemax = 0);
  
  //!Destructor
  ~StructurePlot();
  
  //!plot the structure
  Layout<PixRGB<byte> > draw(const StructureModule& structure, 
                             const uint w = 320, const uint h = 240, 
                             const Dims dims = Dims(0,1),
                             const uint depth = 2);
  
   //!set the probe
  void setProbe(Location probe);
  
private:
  //!get the total number of subs
  uint countSubs(const StructureModule& structure);

  //!plot the structures 2d components
  Layout<byte> drawStructure(const StructureModule& structure, 
                             const uint w = 320, const uint h = 240, 
                             const uint depth = 2);

  //!prohibit copy constructor and assignment
  StructurePlot(const StructurePlot& rhs);
  StructurePlot& operator=(const StructurePlot& rhs);

  NormalizeType itsNormType;
  Range<double> itsRange;
  std::vector<std::string> itsNames;
  int itsTotal, itsCount;
  std::vector<LayerDecoder*> itsDecoder;
  Location itsProbe;
  PlotBufferList itsN;
};

// ######################################################################
// ! inline implementation for StructurePlot
// ######################################################################
inline
StructurePlot::StructurePlot(const StructureModule& structure,
                             const NeuralDecoder& decoder, 
                             const NormalizeType normtype, 
                             const double& rangemin, const double& rangemax) : 
  itsNormType(normtype), itsRange(rangemin, rangemax), 
  itsNames(), itsTotal(countSubs(structure)+1), itsCount(-1), 
  itsDecoder(), itsProbe(), itsN()
{
  for (int ii = 0; ii < itsTotal; ++ii)
    itsDecoder.push_back(new LayerDecoder(decoder, structure.getDims())); 
}

// ######################################################################
inline
StructurePlot::StructurePlot(const StructureModule& structure,
                             const NormalizeType normtype, 
                             const double& rangemin, const double& rangemax) : 
  itsNormType(normtype), itsRange(rangemin, rangemax), 
  itsNames(), itsTotal(countSubs(structure)+1), itsCount(-1), itsDecoder(),
  itsProbe(), itsN()
{
}

// ######################################################################
inline
StructurePlot::~StructurePlot()  
{
  std::vector<LayerDecoder*>::const_iterator 
    begin(itsDecoder.begin()), end(itsDecoder.end());
  while (begin != end)
      delete *begin++;
}

// ######################################################################
void StructurePlot::setProbe(Location probe)
{
  itsN.clear();
  itsProbe = probe; 
};

// ######################################################################
inline
Layout<PixRGB<byte> > 
StructurePlot::draw(const StructureModule& structure,
                    const uint w, const uint h, const Dims dims,
                    const uint depth)
{
  Layout<PixRGB<byte> > out;
  //check for probe and we need to check for initialization
  Image<PixRGB<byte> > ds = drawStructure(structure,w,h,depth).render();
  //if we have a probe collect that info
  if (itsProbe.getDims() > 0)
    {
      itsN.push( structure.getUnit(itsProbe) );
      out = itsN.draw(false, 640, ds.getHeight(), dims);
    }
  //compine the probe and layer plots. 
  out = hcat(ds,out);
  return out;
}

// ######################################################################
inline
Layout<byte> 
StructurePlot::drawStructure(const StructureModule& structure,
                             const uint w, const uint h,
                             const uint depth)
{
  Layout<byte> layout;
  //perform depth first grab of output data
  if (depth != 0)
    for (uint i = 0; i < structure.numSubs(); ++i)
      {
        const StructureModule& temp = structure.getSub(i);
        uint mydepth = depth - 1;
        layout = hcat(layout, drawStructure(temp, w, h, mydepth));
      }
  
  //base case
  ++itsCount;
  Image<double> out;
  if (itsDecoder.size() > 0)
    {
      itsDecoder[itsCount]->push(structure.getOutput());
      out = itsDecoder[itsCount]->getOutput();
    }
  else
    out = structure.getOutput();

  //scale and convert type, rescale if necessary
  Image<byte> outb;
  if (itsNormType == SCALE)
    {
      inplaceNormalize(out, 0.0, 255.0);
      outb = out;
    }
  else
    {
      if (itsNormType == RANGE)
        itsRange.merge(rangeOf(out));
      outb = remapRange(out, itsRange, Range<double>(0.0, 255.0)); 
    }

  outb = rescale(outb, Dims(w,h));
  if ((itsNormType == RANGE) || (itsNormType == SET_RANGE))
    {
      std::string temp = itsNames[itsCount] + " " + 
        convertToString(itsRange.min()) + ":" + 
        convertToString(itsRange.max());
      writeText(outb, Point2D<int>(0,0), temp.c_str());
    }
  else
    writeText(outb, Point2D<int>(0,0), itsNames[itsCount].c_str());

  Rectangle r(Point2D<int>(0,0), Dims(outb.getWidth(),outb.getHeight()));
  drawRectSquareCorners(outb ,r , (byte)255, 2);
  layout = vcat(outb, layout);

  if (itsCount == itsTotal-1)
    itsCount = -1;

  return layout;
}

// ######################################################################
inline
uint StructurePlot::countSubs(const StructureModule& structure)
{
  uint child = 0;
  for (uint i = 0; i < structure.numSubs(); ++i)
    {
      const StructureModule& temp(structure.getSub(i));
      child += countSubs(temp); //recursion = depth first count 
    }
  child += structure.numSubs();
  itsNames.push_back(structure.getName());

  return child;
}

#endif

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

---