#include <itkImage.h>
Inheritance diagram for itk::Image< TPixel, VImageDimension >:
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 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) |
virtual void | Graft (const ImageBase< VImageDimension > *data) |
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 |
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 () |
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 81 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 112 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::SparseImage< TNode, 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. |
|
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 108 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 127 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 121 of file itkImage.h. |
|
Definition at line 145 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 144 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 99 of file itkImage.h. |
|
|
Origin typedef support. The origin is the geometric coordinates of the index (0,0). Reimplemented from itk::ImageBase< VImageDimension >. Definition at line 141 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 133 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 130 of file itkImage.h. |
|
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 137 of file itkImage.h. |
|
|
Typedef alias for PixelType Definition at line 102 of file itkImage.h. |
|
|
|
Definition at line 346 of file itkImage.h. |
|
Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions(). |
|
Fill the image buffer with a value. Be sure to call Allocate() first. |
|
Return a pointer to the beginning of the buffer. This is used by the image iterator class. Definition at line 227 of file itkImage.h. |
|
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. |
|
|
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 203 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 193 of file itkImage.h. |
|
Return the Pixel Accesor object Definition at line 260 of file itkImage.h. |
|
Return the Pixel Accessor object Definition at line 256 of file itkImage.h. |
|
Definition at line 235 of file itkImage.h. |
|
Return a pointer to the container. Definition at line 232 of file itkImage.h. |
|
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 >. |
|
Restore the data object to its initial state. This means releasing memory. Reimplemented from itk::ImageBase< VImageDimension >. Reimplemented in itk::SparseImage< TNode, 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 >. |
|
|
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 220 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 213 of file itkImage.h. |
|
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::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, and itk::BloxImage< BloxCoreAtomPixel< dim >, dim >. |
|
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 183 of file itkImage.h. Referenced by itk::SparseImage< TNode, VImageDimension >::AddNode(). |
|
Set the container to use. Note that this does not cause the DataObject to be modified. |
|
Definition at line 162 of file itkImage.h. |
|
Convenience methods to set the LargestPossibleRegion, BufferedRegion and RequestedRegion. Allocate must still be called. Definition at line 154 of file itkImage.h. |
|
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 314 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 331 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 268 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 290 of file itkImage.h. |