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 TPixel	PixelType
typedef TPixel	ValueType
typedef TPixel	InternalPixelType
typedef DefaultPixelAccessor< PixelType >	AccessorType
typedef ImportImageContainer< unsigned long, PixelType >	PixelContainer
typedef Superclass::IndexType	IndexType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::SizeType	SizeType
typedef Superclass::RegionType	RegionType
typedef Superclass::SpacingType	SpacingType
typedef Superclass::PointType	PointType
typedef PixelContainer::Pointer	PixelContainerPointer
typedef PixelContainer::ConstPointer	PixelContainerConstPointer
Public Member Functions
virtual const char *	GetClassName () 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)
AccessorType	GetPixelAccessor (void)
const AccessorType	GetPixelAccessor (void) 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	CopyInformation (const DataObject *data)
void	SetRegions (RegionType region)
TPixel *	GetBufferPointer ()
const TPixel *	GetBufferPointer () const
virtual void	SetSpacing (SpacingType _arg)
virtual void	SetSpacing (const double spacing[VImageDimension])
virtual void	SetSpacing (const float spacing[VImageDimension])
virtual void	SetOrigin (PointType _arg)
virtual void	SetOrigin (const double origin[VImageDimension])
virtual void	SetOrigin (const float origin[VImageDimension])
template<class TCoordRep> void	TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
template<class TCoordRep> void	TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
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 80 of file itkImage.h.

---

Member Typedef Documentation

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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 110 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::SparseImage< TNode, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 87 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::SparseImage< TNode, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 122 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 106 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 125 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 119 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef PixelContainer::ConstPointer itk::Image< TPixel, VImageDimension >::PixelContainerConstPointer

Definition at line 143 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 142 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 97 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::SparseImage< TNode, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 86 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 >. Definition at line 139 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 131 of file itkImage.h.

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

Standard class typedefs 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 84 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 128 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 >. Definition at line 135 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::SparseImage< TNode, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. Definition at line 85 of file itkImage.h.

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

Typedef alias for PixelType Definition at line 100 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 367 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().

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::Image< TPixel, VImageDimension >::CopyInformation (  const DataObject *  data  )  [virtual]

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. Image has more meta-data than its superclasses Image or ImageBase. Thus, it must provide its own version of CopyInformation() in order to set its Spacing and Origin to match the input parameter. This implementation of CopyInformation() casts the input parameter to an ImageBase. If successful, this method call GetSpacing() and GetOrigin() on its input (since all subclasses of ImageBase are guarenteed to respond to GetSpacing() and GetOrigin()). If "data" is another datatype, this method may not do anything. Reimplemented from itk::ImageBase< VImageDimension >.

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

template<class TPixel, unsigned int VImageDimension = 2> virtual const char* itk::Image< TPixel, VImageDimension >::GetClassName (   )  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::SparseImage< TNode, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >.

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. Definition at line 201 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. Definition at line 191 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 Definition at line 245 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2> AccessorType itk::Image< TPixel, VImageDimension >::GetPixelAccessor (  void   )  [inline]

Return the Pixel Accessor object Definition at line 241 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2> const PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer (   )  const [inline]

Definition at line 233 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2> PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer (   )  [inline]

Return a pointer to the container. Definition at line 230 of file itkImage.h.

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

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

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

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::Image< TPixel, VImageDimension >::SetOrigin (  const float  origin[VImageDimension]  )  [virtual]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float. See also: GetOrigin()

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::Image< TPixel, VImageDimension >::SetOrigin (  const double  origin[VImageDimension]  )  [virtual]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float. See also: GetOrigin()

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::Image< TPixel, VImageDimension >::SetOrigin (  PointType  _arg  )  [virtual]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float. See also: GetOrigin()

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

template<class TPixel, unsigned int VImageDimension = 2> void itk::Image< TPixel, VImageDimension >::SetRegions (  SizeType  size  )  [inline]

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

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::Image< TPixel, VImageDimension >::SetSpacing (  const float  spacing[VImageDimension]  )  [virtual]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float. See also: GetSpacing()

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::Image< TPixel, VImageDimension >::SetSpacing (  const double  spacing[VImageDimension]  )  [virtual]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float. See also: GetSpacing()

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::Image< TPixel, VImageDimension >::SetSpacing (  SpacingType  _arg  )  [virtual]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float. See also: GetSpacing()

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 Definition at line 317 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 Definition at line 334 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 Definition at line 271 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 Definition at line 293 of file itkImage.h.

---

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

• itkImage.h

---