VoxelImage.H

Go to the documentation of this file.

/*!@file PointCloud/VoxelImage.H Open Scene Graph Utils */

// //////////////////////////////////////////////////////////////////// //
// 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: T. Nathan Mundhenk <mundhenk@usc.edu>
// $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/PointCloud/VoxelImage.H $
// $Id: VoxelImage.H 10794 2009-02-08 06:21:09Z itti $
//

#ifndef VOXELIMAGE_H_DEFINED
#define VOXELIMAGE_H_DEFINED

#include "PointCloud/NImage.H"

//! Special voxel image related items such as enums that need a name space
namespace imgvox
{
  enum axis
  {
    X_AXIS,
    Y_AXIS,
    Z_AXIS,
    NO_AXIS
  };
};


// ######################################################################
//! Holds the range of values in a Voxel Image, is useful for point clouds
/*! We use signed integer values since sometimes internal method calls
    will support negative coordinates.
*/
struct VoxRange
{
  //! Range between minX and maxX
  unsigned int rangeX;
  int          minX, maxX;
  //! Range between minY and maxY
  unsigned int rangeY;
  int          minY, maxY;
  //! Range between minZ and maxZ
  unsigned int rangeZ;
  int          minZ, maxZ;
  //! The max range of x,y and z
  unsigned int maxRange;
};

//!Pure Virtual base class for all voxel image types
/*! As one example of how to create a voxel image
    see VirtualVoxel.H and the VirtualVoxel Class.
@param T is the base type of the voxel such as float
@param CLASS_IMAGE is the class of the voxel image
@param BASE_IMAGE is the class of the container that holds the actual data such as an array
*/
template <class T, class CLASS_IMAGE, class BASE_IMAGE>
class VoxelImage : public
NImage<T,CLASS_IMAGE,BASE_IMAGE,3>
{
public:
  virtual ~VoxelImage() {};

  //! Get voxel at x,y,z return false if fails
  virtual bool getVal(const unsigned int x,
                      const unsigned int y,
                      const unsigned int z,
                      T& vox) = 0;

  //! store a voxel at x,y,z
  virtual void setVal(const unsigned int x,
                      const unsigned int y,
                      const unsigned int z,
                      const T& vox) = 0;

  //! get the range of the voxels (useful for sparse images)
  //virtual void range(VoxRange& range) const = 0;

  //! get our height - Y
  virtual unsigned int getHeight() const = 0;

  //! get our width - X
  virtual unsigned int getWidth() const = 0;

  //! get out depth - Z
  virtual unsigned int getDepth() const = 0;
};

#endif

---