NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS > Class Template Reference

#include <PointCloud/NImage.H>

Inheritance diagram for NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >:

[legend]List of all members.

---

Detailed Description

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS>
class NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >

Pure Virtual base class for all N-D image types.

As one example of how to create a N-D image see VirtualVoxel.H and the VirtualVoxel Class (A 3D Image). Note that the CLASS_IMAGE and BASE_IMAGE can be the same if the container class is the only class type. Otherwise this is used to make explicit the container class that includes data and meta data such as dimensions (e.g. height width) as the CLASS_IMAGE and the BASE_IMAGE is just the pure container for the image data. T is the "pixel" type for each point in the N-D image.

Parameters:

	T	is the base type of the voxel such as float
	CLASS_IMAGE	is the class of the N image
	BASE_IMAGE	is the class of the container that holds the actual data such as an array
	DIM	the diminsion of this N image

Definition at line 62 of file NImage.H.

Public Member Functions
virtual	~NImage ()
virtual bool	get (BASE_IMAGE &ivox) const =0
	Return the voxels image. Bool will be false if is empty.
virtual bool	getSlice (const Point< int, DIMS > &coord, Image< T > &img) const =0
	Return an Image Slice, set the normal axis to -1.
virtual bool	getColumn (const Point< int, DIMS > &coord, std::vector< T > &vec) const =0
	Return a vector column, set the normal axis to -1.
virtual bool	getVal (const Point< int, DIMS > &coord, T &val)=0
	Return a single value.
virtual void	set (const BASE_IMAGE &ivox)=0
	Sets the voxel image.
virtual void	setSlice (const Point< int, DIMS > &coord, const Image< T > &img)=0
	Set an Image Slice, set the normal axis to -1.
virtual void	setColumn (const Point< int, DIMS > &coord, const std::vector< T > &vec)=0
	Set a vector column, set the normal axis to -1.
virtual void	setVal (const Point< int, DIMS > &coord, const T &val)=0
	Set a single value.
virtual bool	initialized () const =0
	Check whether image is non-empty (i.e., non-zero height and width).
virtual int	size () const =0
	number of points or voxels we now have
virtual CLASS_IMAGE &	operator= (const CLASS_IMAGE &ivox)=0
	copy operator

---

Member Function Documentation

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual bool NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::get (  BASE_IMAGE &  ivox  )  const [pure virtual]

Return the voxels image. Bool will be false if is empty.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual bool NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::getColumn (  const Point< int, DIMS > &  coord, std::vector< T > &  vec )  const [pure virtual]

Return a vector column, set the normal axis to -1.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual bool NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::getSlice (  const Point< int, DIMS > &  coord, Image< T > &  img )  const [pure virtual]

Return an Image Slice, set the normal axis to -1.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual bool NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::getVal (  const Point< int, DIMS > &  coord, T &  val )  [pure virtual]

Return a single value.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual bool NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::initialized (   )  const [pure virtual]

Check whether image is non-empty (i.e., non-zero height and width). Implemented in RealVoxel< T >, VirtualVoxel< T >, and VirtualVoxel< RETINA_VOXEL_TYPE >.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual CLASS_IMAGE& NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::operator= (  const CLASS_IMAGE &  ivox  )  [pure virtual]

copy operator

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual void NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::set (  const BASE_IMAGE &  ivox  )  [pure virtual]

Sets the voxel image.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual void NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::setColumn (  const Point< int, DIMS > &  coord, const std::vector< T > &  vec )  [pure virtual]

Set a vector column, set the normal axis to -1.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual void NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::setSlice (  const Point< int, DIMS > &  coord, const Image< T > &  img )  [pure virtual]

Set an Image Slice, set the normal axis to -1.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual void NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::setVal (  const Point< int, DIMS > &  coord, const T &  val )  [pure virtual]

Set a single value.

template<class T, class CLASS_IMAGE, class BASE_IMAGE, int DIMS> virtual int NImage< T, CLASS_IMAGE, BASE_IMAGE, DIMS >::size (   )  const [pure virtual]

number of points or voxels we now have Implemented in RealVoxel< T >, VirtualVoxel< T >, and VirtualVoxel< RETINA_VOXEL_TYPE >.

---

The documentation for this class was generated from the following file:

• src/PointCloud/NImage.H

---