Detailed Description

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

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 SmartPointer< const Self >	ConstPointer

typedef WeakPointer< const Self >	ConstWeakPointer

typedef Superclass::DirectionType	DirectionType

typedef Superclass::ImageDimensionType	ImageDimensionType

typedef Superclass::IndexType	IndexType

typedef Superclass::IndexValueType	IndexValueType

typedef TNode *	InternalPixelType

typedef PixelType	IOPixelType

typedef NeighborhoodAccessorFunctor < Self >	NeighborhoodAccessorFunctorType

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 SmartPointer< Self >	Pointer

typedef Superclass::PointType	PointType

typedef Superclass::RegionType	RegionType

typedef Image	Self

typedef Superclass::SizeType	SizeType

typedef Superclass::SizeValueType	SizeValueType

typedef Superclass::SpacingType	SpacingType

typedef Superclass::SpacingValueType	SpacingValueType

typedef ImageBase < VImageDimension >	Superclass

typedef TNode *	ValueType

Public Types inherited from itk::ImageBase< VImageDimension >
typedef SmartPointer< const Self >	ConstPointer

typedef Matrix < SpacePrecisionType, VImageDimension, VImageDimension >	DirectionType

typedef unsigned int	ImageDimensionType

typedef Index< VImageDimension >	IndexType

typedef IndexType::IndexValueType	IndexValueType

typedef Offset< VImageDimension >	OffsetType

typedef OffsetType::OffsetValueType	OffsetValueType

typedef SmartPointer< Self >	Pointer

typedef Point< PointValueType, VImageDimension >	PointType

typedef SpacePrecisionType	PointValueType

typedef ImageRegion < VImageDimension >	RegionType

typedef ImageBase	Self

typedef Size< VImageDimension >	SizeType

typedef SizeType::SizeValueType	SizeValueType

typedef Vector < SpacingValueType, VImageDimension >	SpacingType

typedef SpacePrecisionType	SpacingValueType

typedef DataObject	Superclass

Public Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()

const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const

NodeListType *	GetNodeList ()

virtual void	Initialize () override


NodeType *	AddNode (const IndexType &index)

Public Member Functions inherited from itk::Image< TNode *, VImageDimension >
virtual void	Allocate (bool initializePixels=false) override

virtual ::itk::LightObject::Pointer	CreateAnother () const

void	FillBuffer (const TNode *&value)

NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()

const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const

virtual unsigned int	GetNumberOfComponentsPerPixel () const override

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 Self *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) override

virtual const RegionType &	GetBufferedRegion () const

virtual const DirectionType &	GetDirection () const

virtual const DirectionType &	GetInverseDirection () const

virtual const RegionType &	GetLargestPossibleRegion () const

virtual const PointType &	GetOrigin () const

virtual const RegionType &	GetRequestedRegion () const

virtual const SpacingType &	GetSpacing () const

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

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) override

virtual void	SetRequestedRegionToLargestPossibleRegion () override

template<typename TCoordRep >
void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const

template<typename TCoordRep , typename TIndexRep >
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const

template<typename TCoordRep >
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const

template<typename TCoordRep >
void	TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const

virtual void	UpdateOutputData () override

virtual void	UpdateOutputInformation () override

virtual bool	VerifyRequestedRegion () override

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<typename TCoordRep , typename TIndexRep >
void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const

template<typename 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 () const

SmartPointerForwardReference < ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	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 (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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 ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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 Member Functions inherited from itk::Image< TNode *, VImageDimension >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageBase< VImageDimension >
static unsigned int	GetImageDimension ()

static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::ImageBase< VImageDimension >
static const ImageDimensionType	ImageDimension = VImageDimension

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override

	SparseImage ()

	~SparseImage () override

Protected Member Functions inherited from itk::Image< TNode *, VImageDimension >
virtual void	Graft (const DataObject *data) override

	Image ()

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

virtual	~Image () override

virtual void	ComputeIndexToPhysicalPointMatrices () override

Protected Member Functions inherited from itk::ImageBase< VImageDimension >
void	ComputeOffsetTable ()

	ImageBase ()

virtual void	InitializeBufferedRegion ()

	~ImageBase () override

OffsetValueType	FastComputeOffset (const IndexType &ind) const

IndexType	FastComputeIndex (OffsetValueType offset) const

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

virtual	~DataObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object () override

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 Attributes
NodeListType::Pointer	m_NodeList

NodeStoreType::Pointer	m_NodeStore

Additional Inherited Members
Protected Attributes inherited from itk::ImageBase< VImageDimension >
DirectionType	m_Direction

DirectionType	m_IndexToPhysicalPoint

DirectionType	m_InverseDirection

PointType	m_Origin

DirectionType	m_PhysicalPointToIndex

SpacingType	m_Spacing

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount