ITK: itk::SparseImage< TNode, VImageDimension

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.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 142 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 Superclass::IndexValueType itk::Image< TNode * , VImageDimension >::IndexValueType [inherited]

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 133 of file itkImage.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.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 136 of file itkImage.h.

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

Offset typedef (relative position between indices)

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 160 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 157 of file itkImage.h.

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

A pointer to the pixel container.

Definition at line 156 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).

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 153 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.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 145 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.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 139 of file itkImage.h.

template<unsigned int VImageDimension = 2>

typedef SizeType::SizeValueType itk::ImageBase< VImageDimension >::SizeValueType [inherited]

Definition at line 114 of file itkImageBase.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.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 149 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.

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.

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<unsigned int VImageDimension = 2>

IndexType itk::ImageBase< VImageDimension >::ComputeIndex ( OffsetValueType offset ) const [inline, inherited]

Compute the index of the pixel at a specified offset from the beginning of the buffered region. Bounds checking is not performed. Thus, the computed index could be outside the BufferedRegion. To ensure a valid index, the parameter "offset" should be between 0 and the number of pixels in the BufferedRegion (the latter can be found using ImageRegion::GetNumberOfPixels()).

Definition at line 314 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

OffsetValueType itk::ImageBase< VImageDimension >::ComputeOffset ( const IndexType & ind ) const [inline, inherited]

Compute an offset from the beginning of the buffer for a pixel at the specified index. The index is not checked as to whether it is inside the current buffer, so the computed offset could conceivably be outside the buffer. If bounds checking is needed, one can call ImageRegion::IsInside(ind) on the BufferedRegion prior to calling ComputeOffset.

Definition at line 279 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

void itk::ImageBase< VImageDimension >::ComputeOffsetTable ( ) [protected, inherited]

Calculate the offsets needed to move from one pixel to the next along a row, column, slice, volume, etc. These offsets are based on the size of the BufferedRegion. This should be called after the BufferedRegion is set.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::CopyInformation ( const DataObject * data ) [virtual, inherited]

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. ImageBase has more meta-data than its DataObject. Thus, it must provide its own version of CopyInformation() in order to copy the LargestPossibleRegion from the input parameter.

Reimplemented from itk::DataObject.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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

void itk::DataObject::DataHasBeenGenerated ( ) [inherited]

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

void itk::DataObject::DisconnectPipeline ( ) [inherited]

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

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

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

template<unsigned int VImageDimension = 2>

virtual const RegionType& itk::ImageBase< VImageDimension >::GetBufferedRegion ( ) const [inline, virtual, inherited]

Get the region object that defines the size and starting index of the region of the image currently loaded in memory.

See also:: ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

Definition at line 229 of file itkImageBase.h.

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

Definition at line 242 of file itkImage.h.

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

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 240 of file itkImage.h.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::DataObject::GetDataReleased ( ) const [inline, inherited]

Get the flag indicating the data has been released.

Definition at line 334 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<unsigned int VImageDimension = 2>

virtual const DirectionType& itk::ImageBase< VImageDimension >::GetDirection ( ) [virtual, inherited]

Get the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next. For ImageBase and Image, the default direction is identity.

static bool itk::DataObject::GetGlobalReleaseDataFlag ( ) [static, inherited]

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

template<unsigned int VImageDimension = 2>

static unsigned int itk::ImageBase< VImageDimension >::GetImageDimension ( ) [inline, static, inherited]

Image dimension. The dimension of an image is fixed at construction.

Definition at line 138 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual const RegionType& itk::ImageBase< VImageDimension >::GetLargestPossibleRegion ( ) const [inline, virtual, inherited]

Get the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See also:: ImageRegion, GetBufferedRegion(), GetRequestedRegion()


static bool	GetGlobalReleaseDataFlag ()
static void	SetGlobalReleaseDataFlag (const bool val)
void	GlobalReleaseDataFlagOff ()
void	GlobalReleaseDataFlagOn ()
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 Superclass::IndexValueType	IndexValueType
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 SizeType::SizeValueType	SizeValueType
typedef Superclass::SpacingType	SpacingType
typedef Image< TNode *, VImageDimension >	Superclass
typedef TNode *	ValueType
Public Member Functions
void	Allocate ()
OffsetValueType	ComputeOffset (const IndexType &ind) const
virtual LightObject::Pointer	CreateAnother () const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
void	FillBuffer (const TNode *&value)
virtual const RegionType &	GetBufferedRegion () const
const TNode **	GetBufferPointer () const
TNode **	GetBufferPointer ()
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
virtual const DirectionType &	GetDirection ()
virtual const RegionType &	GetLargestPossibleRegion () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () const
NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()
NodeListType *	GetNodeList ()
virtual const PointType &	GetOrigin ()
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 int	GetReferenceCount () const
virtual const RegionType &	GetRequestedRegion () const
SmartPointerForwardReference< ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual const SpacingType &	GetSpacing ()
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *data)
bool	HasObserver (const EventObject &event) const
virtual void	Initialize ()
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual void	Modified () const
const TNode *&	operator[] (const IndexType &index) const
TNode *&	operator[] (const IndexType &index)
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	ReleaseData ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetBufferedRegion (const RegionType &region)
void	SetDebug (bool debugFlag) const
virtual void	SetDirection (const DirectionType direction)
virtual void	SetLargestPossibleRegion (const RegionType &region)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetPixel (const IndexType &index, const TNode *&value)
void	SetPixelContainer (PixelContainer *container)
virtual void	SetReferenceCount (int)
void	SetRegions (SizeType size)
void	SetRegions (RegionType region)
virtual void	SetRequestedRegion (DataObject *data)
virtual void	SetRequestedRegion (const RegionType &region)
bool	ShouldIReleaseData () const
void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
void	TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
virtual void	UnRegister () const
virtual void	Update ()

NodeType *	AddNode (const IndexType &index)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	CopyInformation (const DataObject *data)
virtual unsigned int	GetNumberOfComponentsPerPixel () const
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	SetNumberOfComponentsPerPixel (unsigned int)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()

const OffsetValueType *	GetOffsetTable () const

virtual const unsigned long &	GetPipelineMTime ()
void	SetPipelineMTime (unsigned long time)

virtual const bool &	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
void	SetReleaseDataFlag (bool flag)

virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	UpdateOutputData ()

virtual void	SetOrigin (const float origin[VImageDimension])
virtual void	SetOrigin (const double origin[VImageDimension])
virtual void	SetOrigin (PointType _arg)

virtual void	SetSpacing (const float spacing[VImageDimension])
virtual void	SetSpacing (const double spacing[VImageDimension])
virtual void	SetSpacing (SpacingType _arg)
Static Public Member Functions
static void	BreakOnError ()
static unsigned int	GetImageDimension ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
void	ComputeOffsetTable ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
	SparseImage ()
	~SparseImage ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
DirectionType	m_Direction
PointType	m_Origin
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
SpacingType	m_Spacing

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

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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