Templated n-dimensional nonrectilinear-coordinate image base class. More...

#include <itkSpecialCoordinatesImage.h>

Inheritance diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >:

Collaboration diagram for itk::SpecialCoordinatesImage< TPixel, VImageDimension >:

Public Types
typedef DefaultPixelAccessorFunctor < Self >	AccessorFunctorType
typedef DefaultPixelAccessor < PixelType >	AccessorType
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef Matrix< double, VImageDimension, VImageDimension >	DirectionType
typedef Superclass::IndexType	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef TPixel	InternalPixelType
typedef PixelType	IOPixelType
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef ImportImageContainer < unsigned long, PixelType >	PixelContainer
typedef PixelContainer::ConstPointer	PixelContainerConstPointer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TPixel	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	PointValueType
typedef Superclass::RegionType	RegionType
typedef SpecialCoordinatesImage	Self
typedef Superclass::SizeType	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef Superclass::SpacingType	SpacingType
typedef double	SpacingValueType
typedef ImageBase < VImageDimension >	Superclass
typedef TPixel	ValueType
Public Member Functions
void	Allocate ()
OffsetValueType	ComputeOffset (const IndexType &ind) const
virtual void	CopyInformation (const DataObject *data)
virtual LightObject::Pointer	CreateAnother () const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
void	DisconnectPipeline ()
void	FillBuffer (const TPixel &value)
virtual const RegionType &	GetBufferedRegion () const
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
virtual const DirectionType &	GetDirection ()
virtual const RegionType &	GetLargestPossibleRegion () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const PointType &	GetOrigin ()
TPixel &	GetPixel (const IndexType &index)
const TPixel &	GetPixel (const IndexType &index) const
AccessorType	GetPixelAccessor (void)
const AccessorType	GetPixelAccessor (void) const
PixelContainer *	GetPixelContainer ()
const PixelContainer *	GetPixelContainer () const
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 &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
TPixel &	operator[] (const IndexType &index)
const TPixel &	operator[] (const IndexType &index) const
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 bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
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 TPixel &value)
void	SetPixelContainer (PixelContainer *container)
virtual void	SetReferenceCount (int)
void	SetRegions (SizeType size)
virtual void	SetRequestedRegion (DataObject *data)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () 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
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()


void	SetRegions (RegionType region)


TPixel *	GetBufferPointer ()
const TPixel *	GetBufferPointer () const


virtual void	SetSpacing (const SpacingType &)
virtual void	SetSpacing (const double[VImageDimension])
virtual void	SetSpacing (const float[VImageDimension])
virtual void	SetOrigin (const PointType)
virtual void	SetOrigin (const double[VImageDimension])
virtual void	SetOrigin (const float[VImageDimension])


const OffsetValueType *	GetOffsetTable () const


IndexType	ComputeIndex (OffsetValueType offset) const


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


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


virtual unsigned int	GetNumberOfComponentsPerPixel () const
virtual void	SetNumberOfComponentsPerPixel (unsigned int)


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


virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)


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


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static unsigned int	GetImageDimension ()
static Pointer	New ()


static void	SetGlobalReleaseDataFlag (bool val)
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalReleaseDataFlagOff ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	ImageDimension = VImageDimension
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	ComputeIndexToPhysicalPointMatrices ()
void	ComputeOffsetTable ()
virtual void	InitializeBufferedRegion (void)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
	SpecialCoordinatesImage ()
virtual	~SpecialCoordinatesImage ()


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

Detailed Description

template<class TPixel, unsigned int VImageDimension = 2>
class itk::SpecialCoordinatesImage< TPixel, VImageDimension >

Templated n-dimensional nonrectilinear-coordinate image base class.

SpecialCoordinatesImages are templated over a pixel type (modeling the dependent variables), and a dimension (number of independent variables). The container for the pixel data is the ImportImageContainer.

Within the pixel container, images are modeled as arrays, defined by a start index and a size.

Almost arbitrary mappings between index space & Cartesian physical space are possible, and so m_Origin and m_Spacing should be ignored. They exist only to allow the possibility of running a "spatially-aware" filter in raw index space, as if the SpecialCoordinatesImage data was laid out on a regular grid. Note that this may or may not produce useful results, and it is up the the user to determine the appropriateness of running a filter designed for normal images on special-coordinates images.

The only correct generic method for operating on a SpecialCoordinatesImage in physical space is to use the virtual functions TransformPhysicalPointToIndex, TransformPhysicalPointToContinuousIndex, TransformIndexToPhysicalPoint, and TransformContinuousIndexToPhysicalPoint. All of these methods transform points in Cartesian physical space to and from indices in the special (typically non-Cartesian) index space. It is also possible to check the type of coordinate representation being used by a SpecialCoordinatesImage, and then use representation-specific code to speed up the filter for certain coordinate representations, falling back to the generic method for unrecognized and/or unoptimized coordinate representations.

There are three sets of meta-data describing portians of a SpecialCoordinatesImages. These are "Region" objects that define a portion of an image via a starting index for the image array and a size. The ivar LargestPossibleRegion defines the size and starting index of the image dataset. The entire image dataset, however, need not be resident in memory. The region of the image that is resident in memory is defined by the "BufferedRegion". The Buffer is a contiguous block of memory. The third set of meta-data defines a region of interest, called the "RequestedRegion". The RequestedRegion is used by the pipeline execution model to define what a filter is requested to produce.

[RegionIndex, RegionSize] C [BufferIndex, BufferSize] C [ImageIndex, ImageSize]

Pixels can be accessed direcly using the SetPixel() and GetPixel() methods or can be accessed via iterators. Begin() creates an iterator that can walk a specified region of a buffer.

The pixel type may be one of the native types; a Insight-defined class type such as Vector; or a user-defined type. Note that depending on the type of pixel that you use, the process objects (i.e., those filters processing data objects) may not operate on the image and/or pixel type. This becomes apparent at compile-time because operator overloading (for the pixel type) is not supported.

The data in an image is arranged in a 1D array as [][][][slice][row][col] with the column index varying most rapidly. The Index type reverses the order so that with Index[0] = col, Index[1] = row, Index[2] = slice, ...

See also:: ImageContainerInterface; Image

Definition at line 96 of file itkSpecialCoordinatesImage.h.

Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 2>

typedef DefaultPixelAccessorFunctor< Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorFunctorType

Accessor functor to choose between accessors: DefaultPixelAccessor for the Image, and DefaultVectorPixelAccessor for the vector image. The functor provides a generic API between the two accessors.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 134 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef DefaultPixelAccessor< PixelType > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 129 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef SmartPointer<const Self> itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstPointer

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 103 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef WeakPointer<const Self> itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstWeakPointer

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 104 of file itkSpecialCoordinatesImage.h.

template<unsigned int VImageDimension = 2>

typedef Matrix<double, VImageDimension, VImageDimension> itk::ImageBase< VImageDimension >::DirectionType [inherited]

Direction typedef support. The Direction is a matix of direction cosines that specify the direction between samples.

Definition at line 139 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::IndexType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IndexType

Index typedef support. An index is used to access pixel values.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 146 of file itkSpecialCoordinatesImage.h.

template<unsigned int VImageDimension = 2>

typedef IndexType::IndexValueType itk::ImageBase< VImageDimension >::IndexValueType [inherited]

Definition at line 110 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::InternalPixelType

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.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 123 of file itkSpecialCoordinatesImage.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IOPixelType

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 125 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::OffsetType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::OffsetType

Offset typedef support. An offset is used to access pixel values.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 149 of file itkSpecialCoordinatesImage.h.

template<unsigned int VImageDimension = 2>

typedef OffsetType::OffsetValueType itk::ImageBase< VImageDimension >::OffsetValueType [inherited]

Definition at line 115 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef ImportImageContainer<unsigned long, PixelType> itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainer

Container used to store pixels in the image.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 143 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelContainer::ConstPointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerConstPointer

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 169 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef PixelContainer::Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerPointer

A pointer to the pixel container.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 168 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 110 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef SmartPointer<Self> itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Pointer

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 102 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::PointType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PointType

Origin typedef support. The origin is the "fake" geometric coordinates of the index (0,0). Also for use w/ filters designed for normal images.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 165 of file itkSpecialCoordinatesImage.h.

template<unsigned int VImageDimension = 2>

typedef double itk::ImageBase< VImageDimension >::PointValueType [inherited]

Origin typedef support. The origin is the geometric coordinates of the index (0,0).

Definition at line 133 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::RegionType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::RegionType

Region typedef support. A region is used to specify a subset of an image.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 155 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef SpecialCoordinatesImage itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Self

Standard class typedefs

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 100 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::SizeType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SizeType

Size typedef support. A size is used to define region bounds.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 152 of file itkSpecialCoordinatesImage.h.

template<unsigned int VImageDimension = 2>

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

Definition at line 119 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::SpacingType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpacingType

Spacing typedef support. Spacing holds the "fake" size of a pixel, making each pixel look like a 1 unit hyper-cube to filters that were designed for normal images and that therefore use m_Spacing. The spacing is the geometric distance between image samples.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 161 of file itkSpecialCoordinatesImage.h.

template<unsigned int VImageDimension = 2>

typedef double itk::ImageBase< VImageDimension >::SpacingValueType [inherited]

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. ITK only supports positive spacing value: negative values may cause undesirable results.

Definition at line 128 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef ImageBase<VImageDimension> itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Superclass

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 101 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ValueType

Typedef alias for PixelType

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 117 of file itkSpecialCoordinatesImage.h.

Constructor & Destructor Documentation

template<class TPixel, unsigned int VImageDimension = 2>

itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpecialCoordinatesImage ( ) [protected]

template<class TPixel, unsigned int VImageDimension = 2>

virtual itk::SpecialCoordinatesImage< TPixel, VImageDimension >::~SpecialCoordinatesImage ( ) [inline, protected, virtual]

Definition at line 314 of file itkSpecialCoordinatesImage.h.

Member Function Documentation

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[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

template<class TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Allocate ( ) [virtual]

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

Reimplemented from itk::ImageBase< VImageDimension >.

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 331 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

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

Compute helper matrices used to transform Index coordinates to PhysicalPoint coordinates and back. This method is virtual and will be overloaded in derived classes in order to provide backward compatibility behavior in classes that did not used to take image orientation into account.

Reimplemented in itk::Image< TPixel, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::Image< BloxCoreAtomPixel< NDimension >, TImageDimension >, itk::Image< TNode *, VImageDimension >, itk::Image< BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, itk::Image< TBloxPixelType, TImageDimension >, and itk::Image< BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

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

template<class TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::FillBuffer ( const TPixel & value )

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 235 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>

TPixel* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetBufferPointer ( ) [inline]

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

Definition at line 249 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetBufferPointer ( ) const [inline]

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

Definition at line 251 of file itkSpecialCoordinatesImage.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]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

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

Definition at line 224 of file itkImageBase.h.

Referenced by itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::SetDeformationField().

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TPixel, unsigned int VImageDimension = 2>

virtual const char* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

template<unsigned int VImageDimension = 2>

virtual unsigned int itk::ImageBase< VImageDimension >::GetNumberOfComponentsPerPixel ( ) const [virtual, inherited]

INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.

Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage

 outputImage->SetNumberOfComponentsPerPixel(
    inputImage->GetNumberOfComponentsPerPixel() )

See also:: ImageBase, VectorImage

Returns/Sets the number of components in the image. Note that for all images this is 1. Even for Image< RGBPixel< T >, 3 >. This is >= 1 only for time-series images such as itk::VectorImage.

Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

template<unsigned int VImageDimension = 2>

const OffsetValueType* itk::ImageBase< VImageDimension >::GetOffsetTable ( ) const [inline, inherited]

Get the offset table. The offset table gives increments for moving from one pixel to next in the current row, column, slice, etc.. This table if of size [VImageDimension+1], because its values are computed progressively as: {1, N1, N1*N2, N1*N2*N3,...,(N1*...*Nn)} Where the values {N1,...,Nn} are the elements of the BufferedRegion::Size array. The last element of the OffsetTable is equivalent to the BufferSize. Having a [VImageDimension+1] size array, simplifies the implementation of some data accessing algorithms. The entries in the offset table are only valid after the BufferedRegion is set.

Definition at line 273 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

virtual const PointType& itk::ImageBase< VImageDimension >::GetOrigin ( ) [virtual, inherited]

Get the origin of the image. The origin is the geometric coordinates of the index (0,0). The value returned is a pointer to a double array. For ImageBase and Image, the default origin is 0.

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( ) [virtual, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixel ( const IndexType & index ) const [inline]

Get a pixel (read only version).

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 217 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixel ( const IndexType & index ) [inline]

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 227 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor ( void ) [inline]

Return the Pixel Accessor object

Definition at line 267 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor ( void ) const [inline]

Return the Pixel Accesor object

Definition at line 271 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer ( ) const [inline]

Definition at line 259 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer ( ) [inline]

Return a pointer to the container.

Definition at line 256 of file itkSpecialCoordinatesImage.h.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

template<unsigned int VImageDimension = 2>

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

Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter).

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

Definition at line 260 of file itkImageBase.h.

SmartPointerForwardReference<ProcessObject> itk::DataObject::GetSource ( ) const [inherited]

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const [inherited]

Which of the source's outputs corresponds to this data object?

template<unsigned int VImageDimension = 2>

virtual const SpacingType& itk::ImageBase< VImageDimension >::GetSpacing ( ) [virtual, inherited]

Get the spacing (size of a pixel) `of the image. The spacing is the geometric distance between image samples. The value returned is a pointer to a double array. For ImageBase and Image, the default data spacing is unity.

virtual unsigned long itk::DataObject::GetUpdateMTime ( ) const [virtual, inherited]

MTime for the last time this DataObject was generated.

static void itk::DataObject::GlobalReleaseDataFlagOff ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 319 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 317 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< 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. Subclasses of ImageBase are responsible for copying the pixel container.

Reimplemented from itk::DataObject.

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Initialize ( ) [virtual]

Restore the data object to its initial state. This means releasing memory.

Reimplemented from itk::ImageBase< VImageDimension >.

template<unsigned int VImageDimension = 2>

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

Restores the buffered region to it's default state This method does not call Modify because Initialization is called by ReleaseData and can not modify the MTime

See also:: ReleaseData, Initialize, SetBufferedRegion

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

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

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TPixel, unsigned int VImageDimension = 2>

static Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

template<class TPixel, unsigned int VImageDimension = 2>

TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator[] ( const IndexType & index ) [inline]

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 237 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator[] ( const IndexType & index ) const [inline]

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 244 of file itkSpecialCoordinatesImage.h.

virtual void itk::DataObject::PrepareForNewData ( ) [inline, virtual, inherited]

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 389 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

virtual void itk::DataObject::PropagateRequestedRegion ( ) throw (InvalidRequestedRegionError) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Propagate a call to ResetPipeline(). Called only from ProcessObject.

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

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

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

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

virtual void itk::DataObject::ReleaseDataFlagOff ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

virtual void itk::DataObject::ReleaseDataFlagOn ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

template<unsigned int VImageDimension = 2>

virtual bool itk::ImageBase< VImageDimension >::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [virtual, inherited]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented from itk::DataObject.

virtual void itk::DataObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetBufferedRegion ( const RegionType & region ) [virtual, inherited]

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

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetDirection ( const DirectionType direction ) [virtual, inherited]

Set the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next.

One row of the matrix indicates the direction cosines of the unit vector that is parallel to the lines of the image grid corresponding to that dimension. For example, and image with Direction matrix

0.866 0.500 -0.500 0.866

has an image grid were the fastest changing index (dimension[0]) walks over a line that in Physical space is oriented parallel to the vector (0.866,0.5). The second fastest changing index (dimension[1]) walks along a line that in Physical space is oriented parallel to the vector (-0.5,0.866)

The vectors whose direction cosines are stored in the Direction matrix, are expected to be orthogonal to each other, and they are expected to form a right handed coordinate system, but this is not checked nor enforced in the itk::ImageBase.

For details, please see:

http://www.itk.org/Wiki/Proposals:Orientation#Some_notes_on_the_DICOM_convention_and_current_ITK_usage

See also:: GetDirection()

static void itk::DataObject::SetGlobalReleaseDataFlag ( bool val ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetLargestPossibleRegion ( const RegionType & region ) [virtual, inherited]

Set 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, SetBufferedRegion(), SetRequestedRegion()

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetNumberOfComponentsPerPixel ( unsigned int ) [virtual, inherited]

INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.

Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage

 outputImage->SetNumberOfComponentsPerPixel(
    inputImage->GetNumberOfComponentsPerPixel() )

See also:: ImageBase, VectorImage

Returns/Sets the number of components in the image. Note that for all images this is 1. Even for Image< RGBPixel< T >, 3 >. This is >= 1 only for time-series images such as itk::VectorImage.

Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const PointType ) [inline, virtual]

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 282 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const double[VImageDimension] ) [inline, virtual]

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 283 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin ( const float[VImageDimension] ) [inline, virtual]

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 284 of file itkSpecialCoordinatesImage.h.

void itk::DataObject::SetPipelineMTime ( unsigned long time ) [inline, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 373 of file itkDataObject.h.

template<class TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixel	(	const IndexType &	index,
		const TPixel &	value
	)			`[inline]`

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 207 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixelContainer ( PixelContainer * container )

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

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

template<class TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetRegions ( SizeType size ) [inline]

Definition at line 186 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetRegions ( RegionType region ) [inline]

Convenience methods to set the LargestPossibleRegion, BufferedRegion and RequestedRegion. Allocate must still be called.

Definition at line 178 of file itkSpecialCoordinatesImage.h.

void itk::DataObject::SetReleaseDataFlag ( bool flag ) [inline, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

template<unsigned int VImageDimension = 2>

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

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to an ImageBase. Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetRequestedRegion ( const RegionType & region ) [virtual, inherited]

Set the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation.

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

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::SetRequestedRegionToLargestPossibleRegion ( ) [virtual, inherited]

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Reimplemented from itk::DataObject.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const float[VImageDimension] ) [inline, virtual]

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 281 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const double[VImageDimension] ) [inline, virtual]

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 280 of file itkSpecialCoordinatesImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing ( const SpacingType & ) [inline, virtual]

These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 279 of file itkSpecialCoordinatesImage.h.

bool itk::DataObject::ShouldIReleaseData ( ) const [inherited]

Return flag indicating whether data should be released after use by a filter.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

void itk::ImageBase< VImageDimension >::TransformContinuousIndexToPhysicalPoint	(	const ContinuousIndex< TCoordRep, VImageDimension > &	index,
		Point< TCoordRep, VImageDimension > &	point
	)			const `[inline, inherited]`

Get a physical point (in the space which the origin and spacing infomation comes from) from a continuous index (in the index space)

See also:: Transform

Definition at line 440 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

void itk::ImageBase< VImageDimension >::TransformIndexToPhysicalPoint	(	const IndexType &	index,
		Point< TCoordRep, VImageDimension > &	point
	)			const `[inline, inherited]`

Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)

See also:: Transform

Definition at line 472 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

void itk::ImageBase< VImageDimension >::TransformLocalVectorToPhysicalVector	(	const FixedArray< TCoordRep, VImageDimension > &	inputGradient,
		FixedArray< TCoordRep, VImageDimension > &	outputGradient
	)			const `[inline, inherited]`

Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)

See also:: Transform Take a vector or covariant vector that has been computed in the coordinate system parallel to the image grid and rotate it by the direction cosines in order to get it in terms of the coordinate system of the image acquisition device. This implementation in the OrientedImage multiply the array (vector or covariant vector) by the matrix of Direction Cosines. The arguments of the method are of type FixedArray to make possible to use this method with both Vector and CovariantVector. The Method is implemented differently in the itk::Image.; Image

Definition at line 507 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

bool itk::ImageBase< 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 412 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

template<class TCoordRep >

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

Get the index (discrete) of a voxel from a physical point. Floating point index results are rounded to integers if ITK_USE_CENTERED_PIXEL_COORDINATES_CONSISTENTLY is on and truncated otherwise. Returns true if the resulting index is within the image, false otherwise

See also:: Transform

Definition at line 382 of file itkImageBase.h.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::DataObject::Update ( ) [virtual, inherited]

Provides opportunity for the data object to insure internal consistency before access. Also causes owning source/filter (if any) to update itself. The Update() method is composed of UpdateOutputInformation(), PropagateRequestedRegion(), and UpdateOutputData(). This method may call methods that throw an InvalidRequestedRegionError exception. This exception will leave the pipeline in an inconsistent state. You will need to call ResetPipeline() on the last ProcessObject in your pipeline in order to restore the pipeline to a state where you can call Update() again.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::UpdateOutputData ( ) [virtual, inherited]

Overriden from base class to check if the requested image region has zero pixels.

This is needed so that filters can set an input's requested region to zero, to indicate that it does not need to be updated or executed.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual void itk::ImageBase< VImageDimension >::UpdateOutputInformation ( ) [virtual, inherited]

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. This method calls its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc.

Reimplemented from itk::DataObject.

template<unsigned int VImageDimension = 2>

virtual bool itk::ImageBase< VImageDimension >::VerifyRequestedRegion ( ) [virtual, inherited]

Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possible satisfy the request. This method returns true if the request can be satisfied and returns fails if the request cannot. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception is the requested region is not within the LargestPossibleRegion.

Reimplemented from itk::DataObject.

Member Data Documentation

template<class TPixel, unsigned int VImageDimension = 2>

const unsigned int itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ImageDimension = VImageDimension [static]

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.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.

Definition at line 140 of file itkSpecialCoordinatesImage.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_Direction [protected, inherited]

Definition at line 646 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_IndexToPhysicalPoint [protected, inherited]

Matrices intended to help with the conversion of Index coordinates to PhysicalPoint coordinates

Definition at line 650 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

PointType itk::ImageBase< VImageDimension >::m_Origin [protected, inherited]

Definition at line 645 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>

DirectionType itk::ImageBase< VImageDimension >::m_PhysicalPointToIndex [protected, inherited]

Definition at line 651 of file itkImageBase.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<unsigned int VImageDimension = 2>

SpacingType itk::ImageBase< VImageDimension >::m_Spacing [protected, inherited]

Origin and spacing of physical coordinates. This variables are protected for efficiency. They are referenced frequently by inner loop calculations.

Definition at line 644 of file itkImageBase.h.

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

itkSpecialCoordinatesImage.h

itk::SpecialCoordinatesImage< TPixel, VImageDimension > Class Template Reference [Image Representation Objects]

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<class TPixel, unsigned int VImageDimension = 2> class itk::SpecialCoordinatesImage< TPixel, VImageDimension >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::SpecialCoordinatesImage< TPixel, VImageDimension > Class Template Reference
[Image Representation Objects]

template<class TPixel, unsigned int VImageDimension = 2>
class itk::SpecialCoordinatesImage< TPixel, VImageDimension >