ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
itk::SparseImage< TNode, VImageDimension > Class Template Reference
Module ITKCommon

A storage type for sparse image data. More...

#include <itkSparseImage.h>

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

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef WeakPointer< const Self > ConstWeakPointer
typedef Superclass::IndexType IndexType
typedef Superclass::IOPixelType IOPixelType
typedef
NeighborhoodAccessorFunctor
< Self > 		NeighborhoodAccessorFunctorType
typedef SparseFieldLayer
< NodeType > 		NodeListType
typedef ObjectStore< NodeType > NodeStoreType
typedef TNode NodeType
typedef SmartPointer< Self > Pointer
typedef SparseImage Self
typedef Image< TNode
*, VImageDimension > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
const
NeighborhoodAccessorFunctorType 		GetNeighborhoodAccessor () const
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
NodeListType * GetNodeList ()
virtual void Initialize ()
NodeType * AddNode (const IndexType &index)

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 SparseImage ()
 ~SparseImage ()

Private Member Functions

void operator= (const Self &)
 SparseImage (const Self &)

Private Attributes

NodeListType::Pointer m_NodeList
NodeStoreType::Pointer m_NodeStore

Detailed Description

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

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. The node type must also have members NodeType* Next and NodeType* Previous. A minimal node class which could be used to create the sparse equivalent of an itk::Image<unsigned char, 2> is shown below:
 struct NodeType
 {
 NodeType* Next;
 NodeType* Previous;
 ImageType::IndexType m_Index;
 unsigned char m_Data;
 };
 typedef itk::SparseImage<NodeType, 2> SparseImageType;
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 67 of file itkSparseImage.h.

Member Typedef Documentation

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 74 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 75 of file itkSparseImage.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 91 of file itkSparseImage.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 98 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 96 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 101 of file itkSparseImage.h.

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

Definition at line 102 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 88 of file itkSparseImage.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 73 of file itkSparseImage.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 71 of file itkSparseImage.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 72 of file itkSparseImage.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 139 of file itkSparseImage.h.

template<class TNode , unsigned int VImageDimension = 2>
itk::SparseImage< TNode, VImageDimension >::SparseImage ( const Self &  ) [private]

Member Function Documentation

template<class TNode , unsigned int VImageDimension = 2>
NodeType* itk::SparseImage< TNode, VImageDimension >::AddNode ( const IndexType &  index) [inline]

This function should be used to allocate memory for a variable at the desired pixel location.

Definition at line 116 of file itkSparseImage.h.

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

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

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

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>
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 106 of file itkSparseImage.h.

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 111 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 128 of file itkSparseImage.h.

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 >.

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 >.

template<class TNode , unsigned int VImageDimension = 2>
void itk::SparseImage< TNode, VImageDimension >::operator= ( const Self &  ) [private]

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

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

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

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

Member Data Documentation

template<class TNode , unsigned int VImageDimension = 2>
const unsigned int itk::SparseImage< TNode, VImageDimension >::ImageDimension = Superclass::ImageDimension [static]

Dimension of the image.

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

Definition at line 85 of file itkSparseImage.h.

template<class TNode , unsigned int VImageDimension = 2>
NodeListType::Pointer itk::SparseImage< TNode, VImageDimension >::m_NodeList [private]

The variables for storing the node variables.

Definition at line 145 of file itkSparseImage.h.

template<class TNode , unsigned int VImageDimension = 2>
NodeStoreType::Pointer itk::SparseImage< TNode, VImageDimension >::m_NodeStore [private]

Definition at line 147 of file itkSparseImage.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 01:26:34 for ITK by doxygen 1.7.4