#include <itkImageBase.h>
Inheritance diagram for itk::ImageBase< VImageDimension >:
ImageBase is the base class for the templated Image classes. ImageBase is templated over the dimension of the image. It provides the API and ivars that depend solely on the dimension of the image. ImageBase does not store any of the image (pixel) data. Storage for the pixels and the pixel access methods are defined in subclasses of ImageBase, namely Image and ImageAdaptor.
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, may 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]
Definition at line 76 of file itkImageBase.h.
|
|||||
|
|||||
|
|||||
|
Reimplemented in itk::BloxCoreAtomImage< dim >. Definition at line 99 of file itkImageBase.h. |
|
|||||
|
|||||
|
Definition at line 104 of file itkImageBase.h. Referenced by itk::ImageBase< VImageDimension >::ComputeOffset(), and itk::ImageBase< VImageDimension >::GetOffsetTable(). |
|
|||||
|
|||||
|
Origin typedef support. The origin is the geometric coordinates of the index (0,0). Reimplemented in itk::Image< TPixel, VImageDimension >, itk::Image< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::Image< TNode *, VImageDimension >, itk::Image< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::Image< BloxCoreAtomPixel< dim >, VImageDimension >, and itk::Image< TBloxPixelType, VImageDimension >. Definition at line 119 of file itkImageBase.h. |
|
|||||
|
|||||
|
|||||
|
|||||
|
Definition at line 108 of file itkImageBase.h. |
|
|||||
|
Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. Reimplemented in itk::Image< TPixel, VImageDimension >, itk::Image< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::Image< TNode *, VImageDimension >, itk::Image< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::Image< BloxCoreAtomPixel< dim >, VImageDimension >, and itk::Image< TBloxPixelType, VImageDimension >. Definition at line 115 of file itkImageBase.h. |
|
|||||
|
|||||||||
|
Compute the index of the pixel at a specified offset from the beginning of the buffered region. |
|
|||||||||
|
Compute the index of the pixel at a specified offset from the beginning of the buffered region. |
|
||||||||||
|
Compute the index of the pixel at a specified offset from the beginning of the buffered region. Definition at line 227 of file itkImageBase.h. References itk::ImageBase< VImageDimension >::IndexType. |
|
||||||||||
|
Compute an offset from the beginning of the buffer for a pixel at the specified index. Definition at line 207 of file itkImageBase.h. References itk::ImageBase< VImageDimension >::IndexType, and itk::ImageBase< VImageDimension >::OffsetValueType. |
|
|||||||||
|
Calculate the offsets needed to move from one pixel to the next along a row, column, slice, volume, etc. These offsets are based on the size of the BufferedRegion. This should be called after the BufferedRegion is 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. ImageBase has more meta-data than its DataObject. Thus, it must provide its own version of CopyInformation() in order to copy the LargestPossibleRegion from the input parameter. Reimplemented from itk::DataObject.
Reimplemented in itk::Image< TPixel, VImageDimension >, itk::Image< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::Image< TNode *, VImageDimension >, itk::Image< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::Image< BloxCoreAtomPixel< dim >, VImageDimension >, and itk::Image< TBloxPixelType, VImageDimension >.
|
|
|||||||||
|
Get the region object that defines the size and starting index of the region of the image currently loaded in memory. Definition at line 165 of file itkImageBase.h.References itk::ImageBase< VImageDimension >::RegionType. |
|
|||||||||
|
|||||||||
|
Image dimension. The dimension of an image is fixed at construction. Definition at line 125 of file itkImageBase.h. |
|
|||||||||
|
Get the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.
References itk::ImageBase< VImageDimension >::RegionType. Referenced by itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >::SetMovingImage(). |
|
|||||||||
|
Get the offset table. The offset table gives increments for moving from one pixel to next in the current row, column, slice, etc.. This table if of size [VImageDimension+1], because its values are computed progressively as: {1, N1, N1*N2, N1*N2*N3,...,(N1*...*Nn)} Where the values {N1,...,Nn} are the elements of the BufferedRegion::Size array. The last element of the OffsetTable is equivalent to the BufferSize. Having a [VImageDimension+1] size array, simplifies the implementation of some data accessing algorithms. Definition at line 202 of file itkImageBase.h. References itk::ImageBase< VImageDimension >::OffsetValueType. |
|
|||||||||
|
Get the origin of the image. The origin is the geometric coordinates of the index (0,0). The value returned is a pointer to a double array. For ImageBase and Image, the default origin is 0. |
|
|||||||||
|
Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). Definition at line 190 of file itkImageBase.h.References itk::ImageBase< VImageDimension >::RegionType. |
|
|||||||||
|
Get the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. The value returned is a pointer to a double array. For ImageBase and Image, the default data spacing is unity. |
|
|||||||||
|
||||||||||||||||||||
|
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 in itk::BloxImage< TBloxPixelType, VImageDimension >, itk::Image< TPixel, VImageDimension >, itk::BloxImage< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::BloxImage< BloxCoreAtomPixel< dim >, dim >, itk::Image< BloxBoundaryPointPixel< VImageDimension >, VImageDimension >, itk::Image< TNode *, VImageDimension >, itk::Image< BloxBoundaryProfilePixel< VImageDimension >, VImageDimension >, itk::Image< BloxCoreAtomPixel< dim >, VImageDimension >, and itk::Image< TBloxPixelType, VImageDimension >.
|
|
|||||||||
|
||||||||||||||||
|
|||||||||
|
Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute Implements itk::DataObject.
|
|
||||||||||
|
Set the region object that defines the size and starting index of the region of the image currently loaded in memory. |
|
||||||||||
|
Set the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.
|
|
||||||||||
|
Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to an ImageBase. Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation. Implements itk::DataObject.
|
|
||||||||||
|
Set the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation. |
|
|||||||||
|
Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update(). Implements itk::DataObject.
|
|
|||||||||
|
Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. This method calls its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Implements itk::DataObject.
|
|
|||||||||
|
Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possible satisfy the request. This method returns true if the request can be satisfied and returns fails if the request cannot. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception is the requested region is not within the LargestPossibleRegion. Implements itk::DataObject.
|
|
|||||
|
Origin and spacing of physical coordinates. Protected so subclasses can access directly. Definition at line 305 of file itkImageBase.h. |
|
|||||
|
Origin and spacing of physical coordinates. Protected so subclasses can access directly. Definition at line 304 of file itkImageBase.h. |
1.3.8 written by Dimitri van Heesch,
© 1997-2000