itk::SparseImage< TNode, VImageDimension > Class Template Reference

#include <itkSparseImage.h>

Inheritance diagram for itk::SparseImage< TNode, VImageDimension >:

[legend]Collaboration diagram for itk::SparseImage< TNode, VImageDimension >:

[legend]List of all members.

---

Detailed Description

template<class TNode, unsigned int VImageDimension = 2>
class itk::SparseImage< TNode, VImageDimension >

This class implements a storage type for sparse image data.

This class is derived from the Image class. It uses the base class image data for storing pointers to variables of type TNode. The node type must have a member variable m_Index. The node data is stored using the SparseFieldLayer and ObjectStore classes to allow sequential list access to the nodes. This functionality is used in filter classes that process the SparseImage class such as FiniteDifferenceSparseImageFilter.

This class provides the method AddNode which allocates a node variable, associates it with the image pixel index (sets m_Index in the node variable) and returns the pointer to the node variable. It is suggested that the user call the FillBuffer method to initialize the image to null pointers before any calls to AddNode. This would allow the user later to distinguish between valid and non-valid pixels.

Definition at line 51 of file itkSparseImage.h.

Public Types
typedef DefaultPixelAccessorFunctor< Self >	AccessorFunctorType
typedef DefaultPixelAccessor< PixelType >	AccessorType
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef Superclass::DirectionType	DirectionType
typedef Superclass::IndexType	IndexType
typedef TNode *	InternalPixelType
typedef Superclass::IOPixelType	IOPixelType
typedef NeighborhoodAccessorFunctor< Self >	NeighborhoodAccessorFunctorType
typedef SparseFieldLayer< NodeType >	NodeListType
typedef ObjectStore< NodeType >	NodeStoreType
typedef TNode	NodeType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef ImportImageContainer< unsigned long, PixelType >	PixelContainer
typedef PixelContainer::ConstPointer	PixelContainerConstPointer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TNode *	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef Superclass::RegionType	RegionType
typedef SparseImage	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SpacingType	SpacingType
typedef Image< TNode *, VImageDimension >	Superclass
typedef TNode *	ValueType
Public Member Functions
This function should be used to allocate memory for a variable at the desired pixel location *NodeType *	AddNode (const IndexType &index)
void	Allocate ()
void	FillBuffer (const TNode *&value)
const TNode **	GetBufferPointer () const
Return a pointer to the beginning of the buffer This is used by *the image iterator class *TNode **	GetBufferPointer ()
virtual const char *	GetNameOfClass () const
const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const
NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()
NodeListType *	GetNodeList ()
TNode *&	GetPixel (const IndexType &index)
const TNode *&	GetPixel (const IndexType &index) const
const AccessorType	GetPixelAccessor (void) const
AccessorType	GetPixelAccessor (void)
const PixelContainer *	GetPixelContainer () const
PixelContainer *	GetPixelContainer ()
virtual void	Graft (const DataObject *data)
virtual void	Initialize ()
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
const TNode *&	operator[] (const IndexType &index) const
TNode *&	operator[] (const IndexType &index)
Get a physical	point (in the space which *the origin and spacing infomation comes from)*from a continuous index(in the index space)*\sa Transform */template< class TCoordRep > void TransformContinuousIndexToPhysicalPoint(const ContinuousIndex< TCoordRep
void	SetPixel (const IndexType &index, const TNode *&value)
void	SetPixelContainer (PixelContainer *container)
void	SetRegions (SizeType size)
Convenience methods to set the *BufferedRegion and RequestedRegion Allocate must still be called *void	SetRegions (RegionType region)
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
Static Public Member Functions
static Pointer	New ()
Public Attributes
Get a physical VImageDimension &	index
Convenience methods to set the	LargestPossibleRegion
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	SparseImage ()
	~SparseImage ()

---

Member Typedef Documentation

typedef DefaultPixelAccessorFunctor< Self > itk::Image< TNode * , VImageDimension >::AccessorFunctorType [inherited]

Definition at line 116 of file itkImage.h.

typedef DefaultPixelAccessor< PixelType > itk::Image< TNode * , VImageDimension >::AccessorType [inherited]

Accessor type that convert data between internal and external representations. Definition at line 115 of file itkImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef SmartPointer<const Self> itk::SparseImage< TNode, VImageDimension >::ConstPointer

Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 58 of file itkSparseImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef WeakPointer<const Self> itk::SparseImage< TNode, VImageDimension >::ConstWeakPointer

Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 59 of file itkSparseImage.h.

typedef Superclass::DirectionType itk::Image< TNode * , VImageDimension >::DirectionType [inherited]

Direction typedef support. A matrix of direction cosines. Definition at line 141 of file itkImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef Superclass::IndexType itk::SparseImage< TNode, VImageDimension >::IndexType

Types derived from the Superclass Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 75 of file itkSparseImage.h.

typedef TNode * itk::Image< TNode * , VImageDimension >::InternalPixelType [inherited]

Internal Pixel representation. Used to maintain a uniform API with Image Adaptors and allow to keep a particular internal representation of data while showing a different external representation. Definition at line 109 of file itkImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef Superclass::IOPixelType itk::SparseImage< TNode, VImageDimension >::IOPixelType

Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 81 of file itkSparseImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef NeighborhoodAccessorFunctor< Self > itk::SparseImage< TNode, VImageDimension >::NeighborhoodAccessorFunctorType

Tyepdef for the functor used to access a neighborhood of pixel pointers. Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 79 of file itkSparseImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef SparseFieldLayer<NodeType> itk::SparseImage< TNode, VImageDimension >::NodeListType

The list types for storing the active pixels. Definition at line 84 of file itkSparseImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef ObjectStore<NodeType> itk::SparseImage< TNode, VImageDimension >::NodeStoreType

Definition at line 85 of file itkSparseImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef TNode itk::SparseImage< TNode, VImageDimension >::NodeType

The actual sparse pixel type. Definition at line 72 of file itkSparseImage.h.

typedef Superclass::OffsetType itk::Image< TNode * , VImageDimension >::OffsetType [inherited]

Offset typedef support. An offset is used to access pixel values. Definition at line 135 of file itkImage.h.

typedef Superclass::OffsetValueType itk::Image< TNode * , VImageDimension >::OffsetValueType [inherited]

Offset typedef (relative position between indices) Definition at line 159 of file itkImage.h.

typedef ImportImageContainer<unsigned long, PixelType> itk::Image< TNode * , VImageDimension >::PixelContainer [inherited]

Container used to store pixels in the image. Definition at line 129 of file itkImage.h.

typedef PixelContainer::ConstPointer itk::Image< TNode * , VImageDimension >::PixelContainerConstPointer [inherited]

Definition at line 156 of file itkImage.h.

typedef PixelContainer::Pointer itk::Image< TNode * , VImageDimension >::PixelContainerPointer [inherited]

A pointer to the pixel container. Definition at line 155 of file itkImage.h.

typedef TNode * itk::Image< TNode * , VImageDimension >::PixelType [inherited]

Pixel typedef support. Used to declare pixel type in filters or other operations. Definition at line 96 of file itkImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef SmartPointer<Self> itk::SparseImage< TNode, VImageDimension >::Pointer

Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 57 of file itkSparseImage.h.

typedef Superclass::PointType itk::Image< TNode * , VImageDimension >::PointType [inherited]

Origin typedef support. The origin is the geometric coordinates of the index (0,0). Definition at line 152 of file itkImage.h.

typedef Superclass::RegionType itk::Image< TNode * , VImageDimension >::RegionType [inherited]

Region typedef support. A region is used to specify a subset of an image. Definition at line 144 of file itkImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef SparseImage itk::SparseImage< TNode, VImageDimension >::Self

Standard typedefs. Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 55 of file itkSparseImage.h.

typedef Superclass::SizeType itk::Image< TNode * , VImageDimension >::SizeType [inherited]

Size typedef support. A size is used to define region bounds. Definition at line 138 of file itkImage.h.

typedef Superclass::SpacingType itk::Image< TNode * , VImageDimension >::SpacingType [inherited]

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. Definition at line 148 of file itkImage.h.

template<class TNode, unsigned int VImageDimension = 2> typedef Image<TNode*, VImageDimension> itk::SparseImage< TNode, VImageDimension >::Superclass

Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 56 of file itkSparseImage.h.

typedef TNode * itk::Image< TNode * , VImageDimension >::ValueType [inherited]

Typedef alias for PixelType Definition at line 103 of file itkImage.h.

---

Constructor & Destructor Documentation

template<class TNode, unsigned int VImageDimension = 2> itk::SparseImage< TNode, VImageDimension >::SparseImage (   )  [protected]

template<class TNode, unsigned int VImageDimension = 2> itk::SparseImage< TNode, VImageDimension >::~SparseImage (   )  [inline, protected]

Definition at line 122 of file itkSparseImage.h.

---

Member Function Documentation

template<class TNode, unsigned int VImageDimension = 2> This function should be used to allocate memory for a variable at the desired pixel location* NodeType* itk::SparseImage< TNode, VImageDimension >::AddNode (  const IndexType &  index  )  [inline]

Definition at line 99 of file itkSparseImage.h.

void itk::Image< TNode * , VImageDimension >::Allocate (   )  [inherited]

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().

void itk::Image< TNode * , VImageDimension >::FillBuffer (  const TNode * &  value  )  [inherited]

Fill the image buffer with a value. Be sure to call Allocate() first.

const TNode * * itk::Image< TNode * , VImageDimension >::GetBufferPointer (   )  const [inline, inherited]

Definition at line 241 of file itkImage.h.

Return a pointer to the beginning of the buffer This is used by* the image iterator class* TNode * * itk::Image< TNode * , VImageDimension >::GetBufferPointer (   )  [inline, inherited]

Definition at line 239 of file itkImage.h.

template<class TNode, unsigned int VImageDimension = 2> virtual const char* itk::SparseImage< TNode, VImageDimension >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Image< TNode *, VImageDimension >.

template<class TNode, unsigned int VImageDimension = 2> const NeighborhoodAccessorFunctorType itk::SparseImage< TNode, VImageDimension >::GetNeighborhoodAccessor (   )  const [inline]

Return the NeighborhoodAccessor functor. This method is called by the neighborhood iterators. Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 94 of file itkSparseImage.h.

template<class TNode, unsigned int VImageDimension = 2> NeighborhoodAccessorFunctorType itk::SparseImage< TNode, VImageDimension >::GetNeighborhoodAccessor (   )  [inline]

Return the NeighborhoodAccessor functor. This method is called by the neighborhood iterators. Reimplemented from itk::Image< TNode *, VImageDimension >. Definition at line 89 of file itkSparseImage.h.

template<class TNode, unsigned int VImageDimension = 2> NodeListType* itk::SparseImage< TNode, VImageDimension >::GetNodeList (   )  [inline]

This function returns the allocated node list which can be used to iterate through the valid nodes. Definition at line 111 of file itkSparseImage.h.

TNode * & itk::Image< TNode * , VImageDimension >::GetPixel (  const IndexType &  index  )  [inline, inherited]

Get a reference to a pixel (e.g. for editing). For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 217 of file itkImage.h.

const TNode * & itk::Image< TNode * , VImageDimension >::GetPixel (  const IndexType &  index  )  const [inline, inherited]

Get a pixel (read only version). For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 207 of file itkImage.h.

const AccessorType itk::Image< TNode * , VImageDimension >::GetPixelAccessor (  void   )  const [inline, inherited]

Return the Pixel Accesor object Definition at line 274 of file itkImage.h.

AccessorType itk::Image< TNode * , VImageDimension >::GetPixelAccessor (  void   )  [inline, inherited]

Return the Pixel Accessor object Definition at line 270 of file itkImage.h.

const PixelContainer* itk::Image< TNode * , VImageDimension >::GetPixelContainer (   )  const [inline, inherited]

Definition at line 249 of file itkImage.h.

PixelContainer* itk::Image< TNode * , VImageDimension >::GetPixelContainer (   )  [inline, inherited]

Return a pointer to the container. Definition at line 246 of file itkImage.h.

virtual void itk::Image< TNode * , VImageDimension >::Graft (  const DataObject *  data  )  [virtual, inherited]

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. The implementation here refers to the superclass' implementation and then copies over the pixel container.

template<class TNode, unsigned int VImageDimension = 2> virtual void itk::SparseImage< TNode, VImageDimension >::Initialize (   )  [virtual]

This function initializes the m_NodeList and m_NodeStore variables, and calls the superclass Initialize method. Reimplemented from itk::Image< TNode *, VImageDimension >.

itk::Image< TNode * , VImageDimension >::itkStaticConstMacro (  ImageDimension  , unsigned  int, VImageDimension  )  [inherited]

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

template<class TNode, unsigned int VImageDimension = 2> itk::SparseImage< TNode, VImageDimension >::itkStaticConstMacro (  ImageDimension  , unsigned  int, Superclass::ImageDimension  )

Dimension of the image.

template<class TNode, unsigned int VImageDimension = 2> static Pointer itk::SparseImage< TNode, VImageDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Image< TNode *, VImageDimension >.

const TNode * & itk::Image< TNode * , VImageDimension >::operator[] (  const IndexType &  index  )  const [inline, inherited]

Access a pixel. This version can only be an rvalue. For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 234 of file itkImage.h.

TNode * & itk::Image< TNode * , VImageDimension >::operator[] (  const IndexType &  index  )  [inline, inherited]

Access a pixel. This version can be an lvalue. For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 227 of file itkImage.h.

Get a physical itk::Image< TNode * , VImageDimension >::point (  in the space which *the origin and spacing infomation comes  from  )  const [inherited]

template<class TNode, unsigned int VImageDimension = 2> void itk::SparseImage< TNode, VImageDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected]

Reimplemented from itk::Image< TNode *, VImageDimension >.

void itk::Image< TNode * , VImageDimension >::SetPixel (  const IndexType &  index, const TNode * &  value )  [inline, inherited]

Set a pixel value. Allocate() needs to have been called first -- for efficiency, this function does not check that the image has actually been allocated yet. Definition at line 197 of file itkImage.h.

void itk::Image< TNode * , VImageDimension >::SetPixelContainer (  PixelContainer *  container  )  [inherited]

Set the container to use. Note that this does not cause the DataObject to be modified.

void itk::Image< TNode * , VImageDimension >::SetRegions (  SizeType  size  )  [inline, inherited]

Definition at line 176 of file itkImage.h.

Convenience methods to set the * BufferedRegion and RequestedRegion Allocate must still be called* void itk::Image< TNode * , VImageDimension >::SetRegions (  RegionType  region  )  [inline, inherited]

Definition at line 168 of file itkImage.h.

bool itk::Image< TNode * , VImageDimension >::TransformPhysicalPointToContinuousIndex (  const Point< TCoordRep, VImageDimension > &  point, ContinuousIndex< TCoordRep, VImageDimension > &  index )  const [inline, inherited]

Get the continuous index from a physical point. Returns true if the resulting index is within the image, false otherwise. See also: Transform Definition at line 291 of file itkImage.h.

bool itk::Image< TNode * , VImageDimension >::TransformPhysicalPointToIndex (  const Point< TCoordRep, VImageDimension > &  point, IndexType &  index )  const [inline, inherited]

Get the index (discrete) from a physical point. Floating point index results are truncated to integers. Returns true if the resulting index is within the image, false otherwise See also: Transform Definition at line 313 of file itkImage.h.

---

Member Data Documentation

Get a physical VImageDimension& itk::Image< TNode * , VImageDimension >::index [inherited]

Definition at line 338 of file itkImage.h.

Convenience methods to set the itk::Image< TNode * , VImageDimension >::LargestPossibleRegion [inherited]

Definition at line 165 of file itkImage.h.

---

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

• itkSparseImage.h

---