 |
ITK
4.0.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.0.0
Insight Segmentation and Registration Toolkit
|
Templated n-dimensional image class. More...
#include <itkImage.h>
Inheritance diagram for itk::Image< TPixel, VImageDimension >: Collaboration diagram for 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, ...
Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, Image1.cxx, Image2.cxx, ImageLinearIteratorWithIndex.cxx, ImageRegionIterator.cxx, ImageRegionIteratorWithIndex.cxx, itkImageIteratorTest.cxx, itkImageSliceIteratorTest.cxx, itkOrthogonalSwath2DPathFilterTest.cxx, itkVectorImageTest.cxx, RGBImage.cxx, and VectorImage.cxx.
Definition at line 86 of file itkImage.h.
| typedef DefaultPixelAccessorFunctor< Self > itk::Image< TPixel, VImageDimension >::AccessorFunctorType |
Definition at line 120 of file itkImage.h.
| typedef DefaultPixelAccessor< PixelType > itk::Image< TPixel, VImageDimension >::AccessorType |
Accessor type that convert data between internal and external representations.
Definition at line 119 of file itkImage.h.
| typedef SmartPointer< const Self > itk::Image< TPixel, VImageDimension >::ConstPointer |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 93 of file itkImage.h.
| typedef WeakPointer< const Self > itk::Image< TPixel, VImageDimension >::ConstWeakPointer |
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 94 of file itkImage.h.
| typedef Superclass::DirectionType itk::Image< TPixel, VImageDimension >::DirectionType |
Direction typedef support. A matrix of direction cosines.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 147 of file itkImage.h.
| 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::SparseImage< TNode, VImageDimension >.
Definition at line 133 of file itkImage.h.
| typedef Superclass::IndexValueType itk::Image< TPixel, VImageDimension >::IndexValueType |
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 134 of file itkImage.h.
| 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.
Definition at line 113 of file itkImage.h.
| typedef PixelType itk::Image< TPixel, VImageDimension >::IOPixelType |
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 115 of file itkImage.h.
| typedef NeighborhoodAccessorFunctor< Self > itk::Image< TPixel, VImageDimension >::NeighborhoodAccessorFunctorType |
Typedef for the functor used to access a neighborhood of pixel pointers.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 124 of file itkImage.h.
| typedef Superclass::OffsetType itk::Image< TPixel, VImageDimension >::OffsetType |
Offset typedef support. An offset is used to access pixel values.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 137 of file itkImage.h.
| typedef Superclass::OffsetValueType itk::Image< TPixel, VImageDimension >::OffsetValueType |
Offset typedef (relative position between indices)
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 167 of file itkImage.h.
| typedef ImportImageContainer< SizeValueType, PixelType > itk::Image< TPixel, VImageDimension >::PixelContainer |
Container used to store pixels in the image.
Definition at line 144 of file itkImage.h.
| typedef PixelContainer::ConstPointer itk::Image< TPixel, VImageDimension >::PixelContainerConstPointer |
Definition at line 164 of file itkImage.h.
| typedef PixelContainer::Pointer itk::Image< TPixel, VImageDimension >::PixelContainerPointer |
A pointer to the pixel container.
Definition at line 163 of file itkImage.h.
| typedef TPixel itk::Image< TPixel, VImageDimension >::PixelType |
Pixel typedef support. Used to declare pixel type in filters or other operations.
Definition at line 100 of file itkImage.h.
| typedef SmartPointer< Self > itk::Image< TPixel, VImageDimension >::Pointer |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 92 of file itkImage.h.
| 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 160 of file itkImage.h.
| 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 >.
Definition at line 151 of file itkImage.h.
| typedef Image itk::Image< TPixel, VImageDimension >::Self |
Standard class typedefs
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 90 of file itkImage.h.
| typedef Superclass::SizeType itk::Image< TPixel, VImageDimension >::SizeType |
Size typedef support. A size is used to define region bounds.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 140 of file itkImage.h.
| typedef Superclass::SizeValueType itk::Image< TPixel, VImageDimension >::SizeValueType |
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 141 of file itkImage.h.
| 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 155 of file itkImage.h.
| typedef Superclass::SpacingValueType itk::Image< TPixel, VImageDimension >::SpacingValueType |
Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. ITK only supports positive spacing value: negative values may cause undesirable results.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 156 of file itkImage.h.
| typedef ImageBase< VImageDimension > itk::Image< TPixel, VImageDimension >::Superclass |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 91 of file itkImage.h.
| typedef TPixel itk::Image< TPixel, VImageDimension >::ValueType |
Typedef alias for PixelType
Definition at line 107 of file itkImage.h.
| itk::Image< TPixel, VImageDimension >::Image | ( | ) | [protected] |
| virtual itk::Image< TPixel, VImageDimension >::~Image | ( | ) | [inline, protected, virtual] |
Definition at line 299 of file itkImage.h.
| itk::Image< TPixel, VImageDimension >::Image | ( | const Self & | ) | [private] |
| void itk::Image< TPixel, VImageDimension >::Allocate | ( | ) | [virtual] |
Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().
Reimplemented from itk::ImageBase< VImageDimension >.
| virtual void itk::Image< TPixel, VImageDimension >::ComputeIndexToPhysicalPointMatrices | ( | ) | [protected, virtual] |
Compute helper matrices used to transform Index coordinates to PhysicalPoint coordinates and back. This method is virtual and will be overloaded in derived classes in order to provide backward compatibility behavior in classes that did not used to take image orientation into account.
Reimplemented from itk::ImageBase< VImageDimension >.
| virtual::itk::LightObject::Pointer itk::Image< TPixel, VImageDimension >::CreateAnother | ( | void | ) | const [virtual] |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
| void itk::Image< TPixel, VImageDimension >::FillBuffer | ( | const TPixel & | value | ) |
Fill the image buffer with a value. Be sure to call Allocate() first.
| virtual TPixel* itk::Image< TPixel, VImageDimension >::GetBufferPointer | ( | ) | [inline, virtual] |
Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Definition at line 248 of file itkImage.h.
| virtual const TPixel* itk::Image< TPixel, VImageDimension >::GetBufferPointer | ( | ) | const [inline, virtual] |
Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Definition at line 250 of file itkImage.h.
| 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::SparseImage< TNode, VImageDimension >.
| NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor | ( | ) | [inline] |
Return the NeighborhoodAccessor functor
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 286 of file itkImage.h.
| const NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor | ( | ) | const [inline] |
Return the NeighborhoodAccessor functor
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Definition at line 290 of file itkImage.h.
| virtual unsigned int itk::Image< TPixel, VImageDimension >::GetNumberOfComponentsPerPixel | ( | ) | const [virtual] |
INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.
Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage
outputImage->SetNumberOfComponentsPerPixel(
inputImage->GetNumberOfComponentsPerPixel() )
Returns/Sets the number of components in the image. Note that for all images this is 1. Even for Image< RGBPixel< T >, 3 >. This is >= 1 only for time-series images such as itk::VectorImage.
Reimplemented from itk::ImageBase< VImageDimension >.
| 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 226 of file itkImage.h.
| 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 216 of file itkImage.h.
| AccessorType itk::Image< TPixel, VImageDimension >::GetPixelAccessor | ( | void | ) | [inline] |
Return the Pixel Accessor object
Definition at line 278 of file itkImage.h.
| const AccessorType itk::Image< TPixel, VImageDimension >::GetPixelAccessor | ( | void | ) | const [inline] |
Return the Pixel Accesor object
Definition at line 282 of file itkImage.h.
| PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer | ( | ) | [inline] |
Return a pointer to the container.
Definition at line 255 of file itkImage.h.
| const PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer | ( | ) | const [inline] |
Definition at line 258 of file itkImage.h.
| 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 >.
| 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 >.
| static Pointer itk::Image< TPixel, VImageDimension >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
Referenced by itk::RegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::AllocateListImage(), and itk::testhelper::ImageRegistrationMethodImageSource< TFixedPixelType, TMovingPixelType, NDimension >::ImageRegistrationMethodImageSource().
| void itk::Image< TPixel, VImageDimension >::operator= | ( | const Self & | ) | [private] |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
| 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 236 of file itkImage.h.
| 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 243 of file itkImage.h.
| void itk::Image< TPixel, VImageDimension >::PrintSelf | ( | std::ostream & | os, |
| Indent | indent | ||
| ) | const [protected, virtual] |
Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::SparseImage< TNode, VImageDimension >.
| 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 206 of file itkImage.h.
| void itk::Image< TPixel, VImageDimension >::SetPixelContainer | ( | PixelContainer * | container | ) |
Set the container to use. Note that this does not cause the DataObject to be modified.
| 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 176 of file itkImage.h.
| void itk::Image< TPixel, VImageDimension >::SetRegions | ( | SizeType | size | ) | [inline] |
Definition at line 184 of file itkImage.h.
const unsigned int itk::Image< TPixel, VImageDimension >::ImageDimension = VImageDimension [static] |
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::SparseImage< TNode, VImageDimension >.
Definition at line 130 of file itkImage.h.
PixelContainerPointer itk::Image< TPixel, VImageDimension >::m_Buffer [private] |
Memory for the current buffer.
Definition at line 313 of file itkImage.h.
1.7.4