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:

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

Collaboration graph
[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 Index< VImageDimension > IndexType
typedef Offset< VImageDimension > OffsetType
typedef Size< VImageDimension > SizeType
typedef ImageRegion< VImageDimension > RegionType
typedef PixelContainer::Pointer PixelContainerPointer
typedef Transform< double,
VImageDimension, VImageDimension > 		TransformType
typedef TransformType::Pointer TransformPointer

Public Methods

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 ()
void SetPixelContainer (PixelContainer *container)
AccessorType GetPixelAccessor (void)
const AccessorType GetPixelAccessor (void) const
TransformPointer GetIndexToPhysicalTransform (void) const
TransformPointer GetPhysicalToIndexTransform (void) const
virtual void RebuildTransforms (void) throw ( std::exception )
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
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
virtual void CopyInformation (const DataObject *data)
void SetRegions (RegionType region)
TPixel * GetBufferPointer ()
const TPixel * GetBufferPointer () const
virtual void SetSpacing (const double spacing[VImageDimension])
virtual void SetSpacing (const float spacing[VImageDimension])
virtual void SetOrigin (const double origin[VImageDimension])
virtual void SetOrigin (const float origin[VImageDimension])
virtual void SetIndexToPhysicalTransform (TransformType *_arg)
virtual void SetPhysicalToIndexTransform (TransformType *_arg)

Static Public Methods

Pointer New ()

Protected Methods

 Image ()
virtual ~Image ()
void PrintSelf (std::ostream &os, Indent indent) const

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

Definition at line 74 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 104 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >.

Definition at line 81 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Index<VImageDimension> 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >.

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

template<class TPixel, unsigned int VImageDimension = 2>
typedef Offset<VImageDimension> 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 119 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 113 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 128 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 91 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >.

Definition at line 80 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef ImageRegion<VImageDimension> 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 125 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >.

Definition at line 78 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Size<VImageDimension> 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 122 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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >.

Definition at line 79 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef TransformType::Pointer itk::Image< TPixel, VImageDimension >::TransformPointer
 

Definition at line 137 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Transform< double, VImageDimension, VImageDimension > itk::Image< TPixel, VImageDimension >::TransformType
 

Typedefs of the Transform Base class associated with the image This transform facilitate the mapping between Indexes and PhysicalPoints. The Image keeps a SmartPointer to a Transform (the base class). Any Transform deriving from itk::Transform can be associated to this pointer.

Definition at line 136 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 94 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 (    )  [protected, virtual]
 

Member Function Documentation

template<class TPixel, unsigned int VImageDimension = 2>
void itk::Image< TPixel, VImageDimension >::Allocate (    ) 
 

Allocate the image memory. The image Dimension and Size must already been set.

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.

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

template<class TPixel, unsigned int VImageDimension = 2>
TransformPointer itk::Image< TPixel, VImageDimension >::GetIndexToPhysicalTransform (  void    )  const
 

Get the index-to-physical coordinate transformation

This method returns an Transform which defines the transformation from index coordinates to physical coordinates determined by the origin and spacing of this image.

template<class TPixel, unsigned int VImageDimension = 2>
TransformPointer itk::Image< TPixel, VImageDimension >::GetPhysicalToIndexTransform (  void    )  const
 

Get the physical-to-index coordinate transformation

This method returns an Transform which defines the transformation from physical coordinates to index coordinates determined by the origin and spacing of this image.

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 194 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 184 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 235 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 231 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 223 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 >.

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::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 211 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 204 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 an offset from the beginning of the buffer for a pixel at the specified index.

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

template<class TPixel, unsigned int VImageDimension = 2>
virtual void itk::Image< TPixel, VImageDimension >::RebuildTransforms (  void    )  throw ( std::exception ) [virtual]
 

Rebuild affine transforms based on origin and spacing

Warning:
This method assumes that Transforms in the image are Affine Transforms. If you require to use an image with different kind of transform you will have to derive a new image class from itk::Image and make sure to overload this method

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

Gets and sets for affine transforms.

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 >::SetPhysicalToIndexTransform (  TransformType *    _arg )  [virtual]
 

Gets and sets for affine transforms.

template<class TPixel, unsigned int VImageDimension = 2>
void itk::Image< TPixel, VImageDimension >::SetPixel (  const IndexType &    index,
const TPixel &    value
)  [inline]
 

Set a pixel value.

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

Definition at line 174 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 155 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 147 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>
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)

Since this function internally uses a Tranform, it is templated over coordinate value type (TCoordRep); using float or double for the coorinate value type is recommended.

Todo:
In future, when MS Visual C++ supports out-of-class member templates, move function definition to itkImage.txx file.
See also:
Transform

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

Since this function internally uses a Tranform, it is templated over coordinate value type (TCoordRep); using float or double for the coorinate value type is recommended.

Todo:
In future, when MS Visual C++ supports out-of-class member templates, move function definition to itkImage.txx file.

See also:
Transform

Definition at line 408 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. Since this function internally uses Tranform, it is templated over coordinate value type (TCoordRep); using float or double for the coordinate value type is recommended.

Todo:
In future, when MS Visual C++ supports out-of-class member templates, move function definition to itkImage.txx file.
See also:
Transform

Definition at line 292 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 Since this function internally uses a Tranform, it is templated over coordinate value type (TCoordRep); using float or double for the coordinate value type is recommended.

Todo:
In future, when MS Visual C++ supports out-of-class member templates, move function definition to itkImage.txx file.
See also:
Transform

Definition at line 329 of file itkImage.h.

The documentation for this class was generated from the following file:
Generated at Wed Mar 12 01:17:03 2003 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000