EnvVisualCortex.H

Go to the documentation of this file.

/*!@file Neuro/EnvVisualCortex.H */

// //////////////////////////////////////////////////////////////////// //
// 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: Rob Peters <rjpeters at usc dot edu>
// $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Neuro/EnvVisualCortex.H $
// $Id: EnvVisualCortex.H 10989 2009-03-05 22:42:20Z itti $
//

#ifndef NEURO_ENVVISUALCORTEX_H_DEFINED
#define NEURO_ENVVISUALCORTEX_H_DEFINED

#include "Component/ModelComponent.H"
#include "Component/ModelParam.H"
#include "Envision/env_params.h"
#include "Envision/env_types.h"
#include "Envision/env_visual_cortex.h"
#include "Image/Image.H"
#include "Image/LevelSpec.H"
#include "Image/Pixels.H"
#include "rutz/shared_ptr.h"

class WorkThreadServer;

extern const ModelOptionDef OPT_EvcMaxnormType;
extern const ModelOptionDef OPT_EvcScaleBits;
#ifdef ENV_WITH_DYNAMIC_CHANNELS
extern const ModelOptionDef OPT_EvcNumDirections;
extern const ModelOptionDef OPT_EvcMotionThresh;
extern const ModelOptionDef OPT_EvcFlickerThresh;
extern const ModelOptionDef OPT_EvcMultiScaleFlicker;
#endif
extern const ModelOptionDef OPT_EvcNumOrientations;
extern const ModelOptionDef OPT_EvcLevelSpec;
extern const ModelOptionDef OPT_EvcType;
extern const ModelOptionDef OPT_EvcColorSmoothing;
extern const ModelOptionDef OPT_EvcOutputFactor;

class EnvVisualCortex : public ModelComponent
{
public:
  EnvVisualCortex(OptionManager& mgr,
      const std::string& descrName = "EnvVisualCortex",
      const std::string& tagName = "EnvVisualCortex");

  virtual ~EnvVisualCortex();

  env_size_t getMapLevel() const { return this->envp.output_map_level; }

  void input(const Image<PixRGB<byte> >& rgbin);

  Image<byte> getVCXmap() const { return itsVCXmap; }

  Image<float> getVCXmapFloat() const {
    // here we convert to float and scale the values in one shot thanks
    // to the built-in automatic type promotions of Image::operator*():
    return itsVCXmap * itsOutputFactor.getVal();
  }

  Image<byte> getImap() const { return itsImap; }
  Image<byte> getCmap() const { return itsCmap; }
  Image<byte> getOmap() const { return itsOmap; }
  byte getIweight() { return envp.chan_i_weight; }
  byte getCweight() { return envp.chan_c_weight; }
  byte getOweight() { return envp.chan_o_weight; }
#ifdef ENV_WITH_DYNAMIC_CHANNELS
  Image<byte> getFmap() const { return itsFmap; }
  Image<byte> getMmap() const { return itsMmap; }
  byte getFweight() { return envp.chan_f_weight; }
  byte getMweight() { return envp.chan_m_weight; }
#endif

  const struct env_params& getParams() const { return envp; }

  bool getColorSmoothing() const { return itsColorSmoothing.getVal(); }

  void setIweight(byte val) { envp.chan_i_weight = val; }
  void setCweight(byte val) { envp.chan_c_weight = val; }
  void setOweight(byte val) { envp.chan_o_weight = val; }

  void setNumOrientations(byte val) { envp.num_orientations = val; }

#ifdef ENV_WITH_DYNAMIC_CHANNELS
  void setFweight(byte val) { envp.chan_f_weight = val; }
  void setMweight(byte val) { envp.chan_m_weight = val; }

  void setFthresh(byte val) { envp.flicker_thresh = val; }
  void setMthresh(byte val) { envp.motion_thresh = val; }

  void setMultiScaleFlicker(bool val) { envp.multiscale_flicker = val ? 1 : 0; }

  void setNumDirections(byte val) { envp.num_motion_directions = val; }
#endif

  void setColorSmoothing(bool val) { itsColorSmoothing.setVal(val); }

#ifdef ENV_WITH_VISIT_CHANNEL
  void setSubmapPreProc(int (*submapPreProc)(const char* tagName,
            env_size_t clev, env_size_t slev, struct env_image *submap,
            const struct env_image *center, const struct env_image *surround))
  { envp.submapPreProc = submapPreProc; }

  void setSubmapPostNormProc(int (*submapPostNormProc)(const char* tagName,
            env_size_t clev, env_size_t slev, struct env_image *submap,
            const struct env_image *center, const struct env_image *surround))
  { envp.submapPostNormProc = submapPostNormProc; }
  void setSubmapPostProc(int (*submapPostProc)(const char* tagName,
            struct env_image *cmap))
  { envp.submapPostProc = submapPostProc; }
#endif

private:
  virtual void paramChanged(ModelParamBase* const param,
                            const bool valueChanged,
                            ParamClient::ChangeStatus* status);

  virtual void start1();

  virtual void stop2();


  NModelParam<byte> itsIweight;
  NModelParam<byte> itsCweight;
  NModelParam<byte> itsOweight;
#ifdef ENV_WITH_DYNAMIC_CHANNELS
  NModelParam<byte> itsFweight;
  NModelParam<byte> itsMweight;
#endif

  OModelParam<bool> itsMultithreaded;
  OModelParam<std::string> itsMaxnormType;
  OModelParam<byte> itsScaleBits;
  OModelParam<byte> itsNumOrientations;
  OModelParam<bool> itsColorSmoothing;
#ifdef ENV_WITH_DYNAMIC_CHANNELS
  OModelParam<byte> itsNumDirections;
  OModelParam<byte> itsMotionThresh;
  OModelParam<byte> itsFlickerThresh;
  OModelParam<int> itsRangeThresh;
  OModelParam<bool> itsMultiScaleFlicker;
#endif
  OModelParam<LevelSpec> itsLevelSpec;

  OModelParam<std::string> itsType;
  OModelParam<float> itsOutputFactor;   //!< output range factor

  struct env_params envp;
  struct env_visual_cortex ivc;

  env_size_t npixels;

  int framenum;

  intg32 chanmi, chanma;
  intg32 vcxmi, vcxma;

  Image<byte> itsVCXmap;

  Image<byte> itsImap;
  Image<byte> itsCmap;
  Image<byte> itsOmap;
#ifdef ENV_WITH_DYNAMIC_CHANNELS
  Image<byte> itsFmap;
  Image<byte> itsMmap;
#endif

  Image<PixRGB<byte> > itsPrevRgb;

  rutz::shared_ptr<WorkThreadServer> itsThreadServer;
};

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

#endif // NEURO_ENVVISUALCORTEX_H_DEFINED

---