#include <itkSparseImage.h>

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

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

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 Types inherited from itk::Image< TNode *, VImageDimension >
typedef DefaultPixelAccessorFunctor < Self >	AccessorFunctorType
typedef DefaultPixelAccessor < PixelType >	AccessorType
typedef Superclass::DirectionType	DirectionType
typedef Superclass::IndexValueType	IndexValueType
typedef TNode *	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef ImportImageContainer < SizeValueType, PixelType >	PixelContainer
typedef PixelContainer::ConstPointer	PixelContainerConstPointer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TNode *	PixelType
typedef Superclass::PointType	PointType
typedef Superclass::RegionType	RegionType
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef Superclass::SpacingType	SpacingType
typedef Superclass::SpacingValueType	SpacingValueType
typedef TNode *	ValueType
Public Types inherited from itk::ImageBase< VImageDimension >
typedef double	PointValueType
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()
const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const
NodeListType *	GetNodeList ()
virtual void	Initialize ()

NodeType *	AddNode (const IndexType &index)
Public Member Functions inherited from itk::Image< TNode *, VImageDimension >
void	Allocate ()
void	FillBuffer (const TNode *&value)
virtual unsigned int	GetNumberOfComponentsPerPixel () const
const TNode *&	GetPixel (const IndexType &index) const
TNode *&	GetPixel (const IndexType &index)
AccessorType	GetPixelAccessor (void)
const AccessorType	GetPixelAccessor (void) const
PixelContainer *	GetPixelContainer ()
const PixelContainer *	GetPixelContainer () const
virtual void	Graft (const DataObject *data)
TNode *&	operator[] (const IndexType &index)
const TNode *&	operator[] (const IndexType &index) const
void	SetPixel (const IndexType &index, const TNode *&value)
void	SetPixelContainer (PixelContainer *container)
virtual TNode **	GetBufferPointer ()
virtual const TNode **	GetBufferPointer () const
Public Member Functions inherited from itk::ImageBase< VImageDimension >
OffsetValueType	ComputeOffset (const IndexType &ind) const
virtual void	CopyInformation (const DataObject *data)
virtual const RegionType &	GetBufferedRegion () const
virtual const DirectionType &	GetDirection ()
virtual const DirectionType &	GetInverseDirection ()
virtual const RegionType &	GetLargestPossibleRegion () const
virtual const PointType &	GetOrigin ()
virtual const RegionType &	GetRequestedRegion () const
virtual const SpacingType &	GetSpacing ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	SetBufferedRegion (const RegionType &region)
virtual void	SetDirection (const DirectionType direction)
virtual void	SetLargestPossibleRegion (const RegionType &region)
virtual void	SetRegions (const SizeType &size)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const DataObject *data)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
template<class TCoordRep >
void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
template<class TCoordRep >
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
template<class TCoordRep >
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
template<class TCoordRep >
void	TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()
virtual void	SetOrigin (PointType _arg)
virtual void	SetOrigin (const double origin[VImageDimension])
virtual void	SetOrigin (const float origin[VImageDimension])
virtual void	SetRegions (const RegionType &region)
const OffsetValueType *	GetOffsetTable () const
IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	SetSpacing (const SpacingType &spacing)
virtual void	SetSpacing (const double spacing[VImageDimension])
virtual void	SetSpacing (const float spacing[VImageDimension])
template<class TCoordRep >
void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
template<class TCoordRep >
void	TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
virtual void	SetNumberOfComponentsPerPixel (unsigned int)
Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
bool	ShouldIReleaseData () const
virtual void	Update ()
void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::Image< TNode *, VImageDimension >
Static Public Attributes inherited from itk::ImageBase< VImageDimension >

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	SparseImage ()
	~SparseImage ()
Protected Member Functions inherited from itk::Image< TNode *, VImageDimension >
virtual void	ComputeIndexToPhysicalPointMatrices ()
	Image ()
virtual	~Image ()
Protected Member Functions inherited from itk::ImageBase< VImageDimension >
void	ComputeOffsetTable ()
	ImageBase ()
virtual void	InitializeBufferedRegion (void)
	~ImageBase ()
Protected Member Functions inherited from itk::DataObject
virtual void	PropagateResetPipeline ()
	DataObject ()
	~DataObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

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.