Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

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

Templated n-dimensional image class. More...

#include <itkImage.h>

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

[legend]Collaboration diagram for itk::Image< TPixel, VImageDimension >:

[legend]List of all members.


Public Types
typedef Image	Self
typedef ImageBase< VImageDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef TPixel	PixelType
typedef TPixel	ValueType
typedef TPixel	InternalPixelType
typedef DefaultPixelAccessor< PixelType >	AccessorType
typedef DefaultPixelAccessorFunctor< Self >	AccessorFunctorType
typedef NeighborhoodAccessorFunctor< Self >	NeighborhoodAccessorFunctorType
typedef ImportImageContainer< unsigned long, PixelType >	PixelContainer
typedef Superclass::IndexType	IndexType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::SizeType	SizeType
typedef Superclass::DirectionType	DirectionType
typedef Superclass::RegionType	RegionType
typedef Superclass::SpacingType	SpacingType
typedef Superclass::PointType	PointType
typedef PixelContainer::Pointer	PixelContainerPointer
typedef PixelContainer::ConstPointer	PixelContainerConstPointer
typedef Superclass::OffsetValueType	OffsetValueType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
void	Allocate ()
void	SetRegions (SizeType size)
virtual void	Initialize ()
void	FillBuffer (const TPixel &value)
void	SetPixel (const IndexType &index, const TPixel &value)
const TPixel &	GetPixel (const IndexType &index) const
TPixel &	GetPixel (const IndexType &index)
TPixel &	operator[] (const IndexType &index)
const TPixel &	operator[] (const IndexType &index) const
PixelContainer *	GetPixelContainer ()
const PixelContainer *	GetPixelContainer () const
void	SetPixelContainer (PixelContainer *container)
virtual void	Graft (const DataObject *data)
AccessorType	GetPixelAccessor (void)
const AccessorType	GetPixelAccessor (void) const
NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor ()
const NeighborhoodAccessorFunctorType	GetNeighborhoodAccessor () 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

void	SetRegions (RegionType region)

TPixel *	GetBufferPointer ()
const TPixel *	GetBufferPointer () 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
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	Image ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~Image ()

Detailed Description

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

Templated n-dimensional image class.

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

There are three sets of meta-data describing an image. 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

DataRepresentation/Image/Image1.cxx DataRepresentation/Image/Image2.cxx DataRepresentation/Image/Image2.cxx DataRepresentation/Image/RGBImage.cxx DataRepresentation/Image/VectorImage.cxx

Definition at line 83 of file itkImage.h.

Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 115 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Accessor type that convert data between internal and external representations.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 114 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 90 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented in itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 91 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::DirectionType itk::Image< TPixel, VImageDimension >::DirectionType

Direction typedef support. A matrix of direction cosines.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::OrientedImage< TPixel, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 140 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Index typedef support. An index is used to access pixel values.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 131 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef TPixel itk::Image< 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::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 110 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef NeighborhoodAccessorFunctor< Self > itk::Image< TPixel, VImageDimension >::NeighborhoodAccessorFunctorType

Tyepdef for the functor used to access a neighborhood of pixel pointers.
Reimplemented in itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 119 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Offset typedef support. An offset is used to access pixel values.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 134 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::OffsetValueType itk::Image< TPixel, VImageDimension >::OffsetValueType

Offset typedef (relative position between indices)
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 158 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Container used to store pixels in the image.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 128 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 155 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

A pointer to the pixel container.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 154 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Pixel typedef support. Used to declare pixel type in filters or other operations.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 101 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 89 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Origin typedef support. The origin is the geometric coordinates of the index (0,0).
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 151 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

typedef Superclass::RegionType itk::Image< 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::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 143 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Size typedef support. A size is used to define region bounds.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 137 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::OrientedImage< TPixel, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 147 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 88 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Typedef alias for PixelType
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 104 of file itkImage.h.

Constructor & Destructor Documentation

template<class TPixel, unsigned int VImageDimension = 2>

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

template<class TPixel, unsigned int VImageDimension = 2>

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

Definition at line 368 of file itkImage.h.

Member Function Documentation

template<class TPixel, unsigned int VImageDimension = 2>

void itk::Image< TPixel, VImageDimension >::Allocate ( )

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

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

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

template<class TPixel, unsigned int VImageDimension = 2>

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

Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 240 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 238 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Run-time type information (and related methods).
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

const NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( ) const [inline]

Return the NeighborhoodAccessor functor
Reimplemented in itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 281 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( ) [inline]

Return the NeighborhoodAccessor functor
Reimplemented in itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 277 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

TPixel& itk::Image< 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.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 216 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::Image< 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.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 206 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Return the Pixel Accesor object
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 273 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Return the Pixel Accessor object
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 269 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 248 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Return a pointer to the container.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.
Definition at line 245 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

virtual void itk::Image< TPixel, VImageDimension >::Graft ( const DataObject * data ) [virtual]

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. The implementation here refers to the superclass' implementation and then copies over the pixel container.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

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

Restore the data object to its initial state. This means releasing memory.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

itk::Image< TPixel, VImageDimension >::itkStaticConstMacro ( ImageDimension ,

unsigned int,

VImageDimension

)

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::BloxImage< TBloxPixelType, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >.

template<class TPixel, unsigned int VImageDimension = 2>

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

Method for creation through the object factory.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

const TPixel& itk::Image< 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 233 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

TPixel& itk::Image< 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 226 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

void itk::Image< TPixel, VImageDimension >::PrintSelf ( std::ostream & os,

Indent indent

) const [protected, virtual]

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()).
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::BloxBoundaryPointImage< VImageDimension >, itk::BloxBoundaryProfileImage< VImageDimension >, itk::BloxCoreAtomImage< dim >, itk::BloxImage< TBloxPixelType, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

void itk::Image< 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 196 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Set the container to use. Note that this does not cause the DataObject to be modified.
Reimplemented in itk::VectorImage< TPixel, VImageDimension >, and itk::VectorImage< TPixelType, Dimension >.

template<class TPixel, unsigned int VImageDimension = 2>

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

Definition at line 175 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

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

Convenience methods to set the LargestPossibleRegion, BufferedRegion and RequestedRegion. Allocate must still be called.
Definition at line 167 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

template<class TCoordRep>

void itk::Image< TPixel, VImageDimension >::TransformContinuousIndexToPhysicalPoint ( const ContinuousIndex< TCoordRep, VImageDimension > & index,

Point< TCoordRep, VImageDimension > & point

) const [inline]

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

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.
Definition at line 336 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

template<class TCoordRep>

void itk::Image< TPixel, VImageDimension >::TransformIndexToPhysicalPoint ( const IndexType & index,

Point< TCoordRep, VImageDimension > & point

) const [inline]

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

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.
Definition at line 353 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

template<class TCoordRep>

bool itk::Image< TPixel, VImageDimension >::TransformPhysicalPointToContinuousIndex ( const Point< TCoordRep, VImageDimension > & point,

ContinuousIndex< TCoordRep, VImageDimension > & index

) const [inline]

Get the continuous index from a physical point.
Returns true if the resulting index is within the image, false otherwise.
See also:
Transform

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.
Definition at line 290 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>

template<class TCoordRep>

bool itk::Image< TPixel, VImageDimension >::TransformPhysicalPointToIndex ( const Point< TCoordRep, VImageDimension > & point,

IndexType & index

) const [inline]

Get the index (discrete) from a physical point. Floating point index results are truncated to integers. Returns true if the resulting index is within the image, false otherwise
See also:
Transform

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.
Definition at line 312 of file itkImage.h.

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

itkImage.h

Generated at Thu May 25 01:12:13 2006 for ITK by

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

Public Types

Public Member Functions

Static Public Member Functions