ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkSpecialCoordinatesImage.h>
Public Types | |
typedef DefaultPixelAccessorFunctor < Self > | AccessorFunctorType |
typedef DefaultPixelAccessor < PixelType > | AccessorType |
typedef SmartPointer< const Self > | ConstPointer |
typedef WeakPointer< const Self > | ConstWeakPointer |
typedef Superclass::IndexType | IndexType |
typedef TPixel | InternalPixelType |
typedef PixelType | IOPixelType |
typedef Superclass::OffsetType | OffsetType |
typedef ImportImageContainer < SizeValueType, PixelType > | PixelContainer |
typedef PixelContainer::ConstPointer | PixelContainerConstPointer |
typedef PixelContainer::Pointer | PixelContainerPointer |
typedef TPixel | PixelType |
typedef SmartPointer< Self > | Pointer |
typedef Superclass::PointType | PointType |
typedef Superclass::RegionType | RegionType |
typedef SpecialCoordinatesImage | Self |
typedef Superclass::SizeType | SizeType |
typedef Superclass::SpacingType | SpacingType |
typedef ImageBase < VImageDimension > | Superclass |
typedef TPixel | ValueType |
Public Member Functions | |
void | Allocate () |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
void | FillBuffer (const TPixel &value) |
virtual const char * | GetNameOfClass () const |
const TPixel & | GetPixel (const IndexType &index) const |
TPixel & | GetPixel (const IndexType &index) |
AccessorType | GetPixelAccessor (void) |
const AccessorType | GetPixelAccessor (void) const |
PixelContainer * | GetPixelContainer () |
const PixelContainer * | GetPixelContainer () const |
virtual void | Initialize () |
TPixel & | operator[] (const IndexType &index) |
const TPixel & | operator[] (const IndexType &index) const |
void | SetPixel (const IndexType &index, const TPixel &value) |
void | SetPixelContainer (PixelContainer *container) |
void | SetRegions (SizeType size) |
void | SetRegions (RegionType region) |
TPixel * | GetBufferPointer () |
const TPixel * | GetBufferPointer () const |
virtual void | SetSpacing (const SpacingType &) |
virtual void | SetSpacing (const double[VImageDimension]) |
virtual void | SetSpacing (const float[VImageDimension]) |
virtual void | SetOrigin (const PointType) |
virtual void | SetOrigin (const double[VImageDimension]) |
virtual void | SetOrigin (const float[VImageDimension]) |
Static Public Member Functions | |
static Pointer | New () |
Static Public Attributes | |
static const unsigned int | ImageDimension = VImageDimension |
Protected Member Functions | |
void | PrintSelf (std::ostream &os, Indent indent) const |
SpecialCoordinatesImage () | |
virtual | ~SpecialCoordinatesImage () |
Private Member Functions | |
void | operator= (const Self &) |
SpecialCoordinatesImage (const Self &) | |
Private Attributes | |
PixelContainerPointer | m_Buffer |
Templated n-dimensional nonrectilinear-coordinate image base class.
SpecialCoordinatesImages 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.
Almost arbitrary mappings between index space & Cartesian physical space are possible, and so m_Origin and m_Spacing should be ignored. They exist only to allow the possibility of running a "spatially-aware" filter in raw index space, as if the SpecialCoordinatesImage data was laid out on a regular grid. Note that this may or may not produce useful results, and it is up the the user to determine the appropriateness of running a filter designed for normal images on special-coordinates images.
The only correct generic method for operating on a SpecialCoordinatesImage in physical space is to use the virtual functions TransformPhysicalPointToIndex, TransformPhysicalPointToContinuousIndex, TransformIndexToPhysicalPoint, and TransformContinuousIndexToPhysicalPoint. All of these methods transform points in Cartesian physical space to and from indices in the special (typically non-Cartesian) index space. It is also possible to check the type of coordinate representation being used by a SpecialCoordinatesImage, and then use representation-specific code to speed up the filter for certain coordinate representations, falling back to the generic method for unrecognized and/or unoptimized coordinate representations.
There are three sets of meta-data describing portions of a SpecialCoordinatesImages. 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 95 of file itkSpecialCoordinatesImage.h.
typedef DefaultPixelAccessorFunctor< Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorFunctorType |
Accessor functor to choose between accessors: DefaultPixelAccessor for the Image, and DefaultVectorPixelAccessor for the vector image. The functor provides a generic API between the two accessors.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 133 of file itkSpecialCoordinatesImage.h.
typedef DefaultPixelAccessor< PixelType > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::AccessorType |
Accessor type that convert data between internal and external representations.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 128 of file itkSpecialCoordinatesImage.h.
typedef SmartPointer< const Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstPointer |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 102 of file itkSpecialCoordinatesImage.h.
typedef WeakPointer< const Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ConstWeakPointer |
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 103 of file itkSpecialCoordinatesImage.h.
typedef Superclass::IndexType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IndexType |
Index typedef support. An index is used to access pixel values.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 142 of file itkSpecialCoordinatesImage.h.
typedef TPixel itk::SpecialCoordinatesImage< 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::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 122 of file itkSpecialCoordinatesImage.h.
typedef PixelType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::IOPixelType |
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 124 of file itkSpecialCoordinatesImage.h.
typedef Superclass::OffsetType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::OffsetType |
Offset typedef support. An offset is used to access pixel values.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 145 of file itkSpecialCoordinatesImage.h.
typedef ImportImageContainer< SizeValueType, PixelType > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainer |
Container used to store pixels in the image.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 151 of file itkSpecialCoordinatesImage.h.
typedef PixelContainer::ConstPointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerConstPointer |
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 169 of file itkSpecialCoordinatesImage.h.
typedef PixelContainer::Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelContainerPointer |
A pointer to the pixel container.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 168 of file itkSpecialCoordinatesImage.h.
typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PixelType |
Pixel typedef support. Used to declare pixel type in filters or other operations.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 109 of file itkSpecialCoordinatesImage.h.
typedef SmartPointer< Self > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Pointer |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 101 of file itkSpecialCoordinatesImage.h.
typedef Superclass::PointType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::PointType |
Origin typedef support. The origin is the "fake" geometric coordinates of the index (0,0). Also for use w/ filters designed for normal images.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 165 of file itkSpecialCoordinatesImage.h.
typedef Superclass::RegionType itk::SpecialCoordinatesImage< 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::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 155 of file itkSpecialCoordinatesImage.h.
typedef SpecialCoordinatesImage itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Self |
Standard class typedefs
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 99 of file itkSpecialCoordinatesImage.h.
typedef Superclass::SizeType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SizeType |
Size typedef support. A size is used to define region bounds.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 148 of file itkSpecialCoordinatesImage.h.
typedef Superclass::SpacingType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpacingType |
Spacing typedef support. Spacing holds the "fake" size of a pixel, making each pixel look like a 1 unit hyper-cube to filters that were designed for normal images and that therefore use m_Spacing. The spacing is the geometric distance between image samples.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 161 of file itkSpecialCoordinatesImage.h.
typedef ImageBase< VImageDimension > itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Superclass |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 100 of file itkSpecialCoordinatesImage.h.
typedef TPixel itk::SpecialCoordinatesImage< TPixel, VImageDimension >::ValueType |
Typedef alias for PixelType
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 116 of file itkSpecialCoordinatesImage.h.
itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpecialCoordinatesImage | ( | ) | [protected] |
virtual itk::SpecialCoordinatesImage< TPixel, VImageDimension >::~SpecialCoordinatesImage | ( | ) | [inline, protected, virtual] |
Definition at line 307 of file itkSpecialCoordinatesImage.h.
itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SpecialCoordinatesImage | ( | const Self & | ) | [private] |
void itk::SpecialCoordinatesImage< 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::itk::LightObject::Pointer itk::SpecialCoordinatesImage< 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::PhasedArray3DSpecialCoordinatesImage< TPixel >.
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::FillBuffer | ( | const TPixel & | value | ) |
Fill the image buffer with a value. Be sure to call Allocate() first.
TPixel* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetBufferPointer | ( | ) | [inline] |
Return a pointer to the beginning of the buffer. This is used by the image iterator class.
Definition at line 248 of file itkSpecialCoordinatesImage.h.
const TPixel* itk::SpecialCoordinatesImage< 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 249 of file itkSpecialCoordinatesImage.h.
virtual const char* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
const TPixel& itk::SpecialCoordinatesImage< 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 218 of file itkSpecialCoordinatesImage.h.
TPixel& itk::SpecialCoordinatesImage< 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 228 of file itkSpecialCoordinatesImage.h.
AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor | ( | void | ) | [inline] |
Return the Pixel Accessor object
Definition at line 262 of file itkSpecialCoordinatesImage.h.
const AccessorType itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelAccessor | ( | void | ) | const [inline] |
Return the Pixel Accesor object
Definition at line 265 of file itkSpecialCoordinatesImage.h.
PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer | ( | ) | [inline] |
Return a pointer to the container.
Definition at line 253 of file itkSpecialCoordinatesImage.h.
const PixelContainer* itk::SpecialCoordinatesImage< TPixel, VImageDimension >::GetPixelContainer | ( | ) | const [inline] |
Definition at line 255 of file itkSpecialCoordinatesImage.h.
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::Initialize | ( | ) | [virtual] |
Restore the data object to its initial state. This means releasing memory.
Reimplemented from itk::ImageBase< VImageDimension >.
static Pointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::operator= | ( | const Self & | ) | [private] |
Reimplemented from itk::ImageBase< VImageDimension >.
Reimplemented in itk::PhasedArray3DSpecialCoordinatesImage< TPixel >.
TPixel& itk::SpecialCoordinatesImage< 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 238 of file itkSpecialCoordinatesImage.h.
const TPixel& itk::SpecialCoordinatesImage< 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 244 of file itkSpecialCoordinatesImage.h.
void itk::SpecialCoordinatesImage< 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::PhasedArray3DSpecialCoordinatesImage< TPixel >.
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin | ( | const PointType | ) | [inline, virtual] |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 275 of file itkSpecialCoordinatesImage.h.
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin | ( | const double | [VImageDimension] | ) | [inline, virtual] |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 276 of file itkSpecialCoordinatesImage.h.
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetOrigin | ( | const float | [VImageDimension] | ) | [inline, virtual] |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 277 of file itkSpecialCoordinatesImage.h.
void itk::SpecialCoordinatesImage< 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 208 of file itkSpecialCoordinatesImage.h.
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetPixelContainer | ( | PixelContainer * | container | ) |
Set the container to use. Note that this does not cause the DataObject to be modified.
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetRegions | ( | RegionType | region | ) | [inline] |
Convenience methods to set the LargestPossibleRegion, BufferedRegion and RequestedRegion. Allocate must still be called.
Definition at line 178 of file itkSpecialCoordinatesImage.h.
void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetRegions | ( | SizeType | size | ) | [inline] |
Definition at line 186 of file itkSpecialCoordinatesImage.h.
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing | ( | const SpacingType & | ) | [inline, virtual] |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 272 of file itkSpecialCoordinatesImage.h.
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing | ( | const double | [VImageDimension] | ) | [inline, virtual] |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 273 of file itkSpecialCoordinatesImage.h.
virtual void itk::SpecialCoordinatesImage< TPixel, VImageDimension >::SetSpacing | ( | const float | [VImageDimension] | ) | [inline, virtual] |
These functions do NOTHING! They exist only to not break the pipeline. It is vital that the user specify any and all physical-spacing parameters to the output of a normal filter which is being used to output a special-coordinates image. Filters designed to produce a particular kind of special-coordinates image should do this automatically.
Reimplemented from itk::ImageBase< VImageDimension >.
Definition at line 274 of file itkSpecialCoordinatesImage.h.
const unsigned int itk::SpecialCoordinatesImage< 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::PhasedArray3DSpecialCoordinatesImage< TPixel >.
Definition at line 139 of file itkSpecialCoordinatesImage.h.
PixelContainerPointer itk::SpecialCoordinatesImage< TPixel, VImageDimension >::m_Buffer [private] |
Memory for the current buffer.
Definition at line 313 of file itkSpecialCoordinatesImage.h.