#include <itkImage.h>
Inheritance diagram for itk::Image:
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 |
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 |
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 (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]) |
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 Methods | |
Pointer | New () |
Protected Methods | |
Image () | |
virtual | ~Image () |
void | PrintSelf (std::ostream &os, Indent indent) const |
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, ...
Definition at line 79 of file itkImage.h.
|
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 109 of file itkImage.h. |
|
|
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 121 of file itkImage.h. |
|
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 105 of file itkImage.h. |
|
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 124 of file itkImage.h. |
|
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 118 of file itkImage.h. |
|
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 133 of file itkImage.h. |
|
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 96 of file itkImage.h. |
|
|
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 130 of file itkImage.h. |
|
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 83 of file itkImage.h. |
|
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 127 of file itkImage.h. |
|
|
Typedef alias for PixelType Definition at line 99 of file itkImage.h. |
|
|
|
|
|
Allocate the image memory. The image Dimension and Size must already been set. |
|
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 >. |
|
Fill the image buffer with a value. |
|
Return a pointer to the beginning of the buffer. This is used by the image iterator class. Definition at line 213 of file itkImage.h. |
|
Return a pointer to the beginning of the buffer. This is used by the image iterator class. Definition at line 211 of file itkImage.h. |
|
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 >. |
|
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 189 of file itkImage.h. |
|
Get a pixel (read only version). For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 179 of file itkImage.h. |
|
Return the Pixel Accesor object Definition at line 230 of file itkImage.h. |
|
Return the Pixel Accessor object Definition at line 226 of file itkImage.h. |
|
Return a pointer to the container. Definition at line 218 of file itkImage.h. |
|
Restore the data object to its initial state. This means releasing memory. Reimplemented from itk::ImageBase< 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 >. |
|
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 >. |
|
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 206 of file itkImage.h. |
|
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 199 of file itkImage.h. |
|
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 >. |
|
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.
|
|
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.
|
|
Set a pixel value. For efficiency, this function does not check that the image has actually been allocated yet. Definition at line 169 of file itkImage.h. |
|
Set the container to use. Note that this does not cause the DataObject to be modified. |
|
Definition at line 150 of file itkImage.h. |
|
Convenience methods to set the LargestPossibleRegion, BufferedRegion and RequestedRegion. Allocate must still be called. Definition at line 142 of file itkImage.h. |
|
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.
|
|
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.
|
|
Get a physical point (in the space which the origin and spacing infomation comes from) from a continuous index (in the index space)
Definition at line 300 of file itkImage.h. |
|
Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)
Definition at line 317 of file itkImage.h. |
|
Get the continuous index from a physical point. Returns true if the resulting index is within the image, false otherwise.
Definition at line 254 of file itkImage.h. |
|
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
Definition at line 276 of file itkImage.h. |