Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::Image< TPixel, VImageDimension > Class Template Reference

#include <itkImage.h>

Inheritance diagram for itk::Image< TPixel, VImageDimension >:

Inheritance graph
[legend]
Collaboration diagram for itk::Image< TPixel, VImageDimension >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class TPixel, unsigned int VImageDimension = 2>
class 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, ...

See also:
ImageContainerInterface
Examples:

Common/itkImageSliceIteratorTest.cxx, DataRepresentation/Image/Image1.cxx, DataRepresentation/Image/Image2.cxx, DataRepresentation/Image/RGBImage.cxx, DataRepresentation/Image/VectorImage.cxx, Examples/Iterators/ImageLinearIteratorWithIndex.cxx, Iterators/ImageRegionIterator.cxx, Iterators/ImageRegionIteratorWithIndex.cxx, and Testing/Code/Common/itkVectorImageTest.cxx.

Definition at line 82 of file itkImage.h.
static bool GetGlobalReleaseDataFlag ()
static void SetGlobalReleaseDataFlag (const bool val)
void GlobalReleaseDataFlagOff ()
void GlobalReleaseDataFlagOn ()

Public Types

typedef DefaultPixelAccessorFunctor<
Self
AccessorFunctorType
typedef DefaultPixelAccessor<
PixelType
AccessorType
typedef SmartPointer< const
Self
ConstPointer
typedef WeakPointer< const
Self
ConstWeakPointer
typedef Superclass::DirectionType DirectionType
typedef Superclass::IndexType IndexType
typedef IndexType::IndexValueType IndexValueType
typedef TPixel InternalPixelType
typedef PixelType IOPixelType
typedef NeighborhoodAccessorFunctor<
Self
NeighborhoodAccessorFunctorType
typedef Superclass::OffsetType OffsetType
typedef Superclass::OffsetValueType OffsetValueType
typedef ImportImageContainer<
unsigned long, PixelType
PixelContainer
typedef PixelContainer::ConstPointer PixelContainerConstPointer
typedef PixelContainer::Pointer PixelContainerPointer
typedef TPixel PixelType
typedef SmartPointer< SelfPointer
typedef Superclass::PointType PointType
typedef Superclass::RegionType RegionType
typedef Image Self
typedef Superclass::SizeType SizeType
typedef SizeType::SizeValueType SizeValueType
typedef Superclass::SpacingType SpacingType
typedef ImageBase< VImageDimension > Superclass
typedef TPixel ValueType

Public Member Functions

void Allocate ()
OffsetValueType ComputeOffset (const IndexType &ind) const
virtual LightObject::Pointer CreateAnother () const
void DataHasBeenGenerated ()
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
void DisconnectPipeline ()
void FillBuffer (const TPixel &value)
virtual const RegionTypeGetBufferedRegion () const
CommandGetCommand (unsigned long tag)
bool GetDataReleased () const
bool GetDebug () const
virtual const DirectionTypeGetDirection ()
virtual const RegionTypeGetLargestPossibleRegion () const
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
const NeighborhoodAccessorFunctorType GetNeighborhoodAccessor () const
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
virtual const PointTypeGetOrigin ()
TPixel & GetPixel (const IndexType &index)
const TPixel & GetPixel (const IndexType &index) const
const AccessorType GetPixelAccessor (void) const
AccessorType GetPixelAccessor (void)
const PixelContainerGetPixelContainer () const
PixelContainerGetPixelContainer ()
virtual int GetReferenceCount () const
virtual const RegionTypeGetRequestedRegion () const
SmartPointerForwardReference<
ProcessObject
GetSource () const
unsigned int GetSourceOutputIndex () const
virtual const SpacingTypeGetSpacing ()
virtual unsigned long GetUpdateMTime () const
virtual void Graft (const DataObject *data)
bool HasObserver (const EventObject &event) const
virtual void Initialize ()
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
 itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
virtual void Modified () const
const TPixel & operator[] (const IndexType &index) const
TPixel & operator[] (const IndexType &index)
virtual void PrepareForNewData ()
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void ReleaseData ()
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
virtual void ResetPipeline ()
virtual void SetBufferedRegion (const RegionType &region)
void SetDebug (bool debugFlag) const
virtual void SetDirection (const DirectionType direction)
virtual void SetLargestPossibleRegion (const RegionType &region)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
void SetPixel (const IndexType &index, const TPixel &value)
void SetPixelContainer (PixelContainer *container)
virtual void SetReferenceCount (int)
void SetRegions (SizeType size)
virtual void SetRequestedRegion (DataObject *data)
virtual void SetRequestedRegion (const RegionType &region)
bool ShouldIReleaseData () 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 UnRegister () const
virtual void Update ()
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
IndexType ComputeIndex (OffsetValueType offset) const
virtual void CopyInformation (const DataObject *data)
virtual unsigned int GetNumberOfComponentsPerPixel () const
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void SetNumberOfComponentsPerPixel (unsigned int)
virtual void SetRequestedRegionToLargestPossibleRegion ()
virtual void UpdateOutputInformation ()
virtual bool VerifyRequestedRegion ()
const TPixel * GetBufferPointer () const
TPixel * GetBufferPointer ()
const OffsetValueTypeGetOffsetTable () const
virtual const unsigned long & GetPipelineMTime ()
void SetPipelineMTime (unsigned long time)
virtual const bool & GetReleaseDataFlag ()
virtual void ReleaseDataFlagOff ()
virtual void ReleaseDataFlagOn ()
void SetReleaseDataFlag (bool flag)
virtual void PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void UpdateOutputData ()
virtual void SetOrigin (const float origin[VImageDimension])
virtual void SetOrigin (const double origin[VImageDimension])
virtual void SetOrigin (PointType _arg)
void SetRegions (RegionType region)
virtual void SetSpacing (const float spacing[VImageDimension])
virtual void SetSpacing (const double spacing[VImageDimension])
virtual void SetSpacing (SpacingType _arg)
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

static void BreakOnError ()
static unsigned int GetImageDimension ()
static Pointer New ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static void SetGlobalWarningDisplay (bool flag)

Protected Member Functions

void ComputeOffsetTable ()
 Image ()
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PropagateResetPipeline ()
virtual ~Image ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

DirectionType m_Direction
PointType m_Origin
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
SpacingType m_Spacing


Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 2>
typedef DefaultPixelAccessorFunctor< Self > itk::Image< TPixel, VImageDimension >::AccessorFunctorType

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.

Definition at line 116 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef DefaultPixelAccessor< PixelType > itk::Image< TPixel, VImageDimension >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 115 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef SmartPointer<const Self> itk::Image< TPixel, VImageDimension >::ConstPointer

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 89 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef WeakPointer<const Self> itk::Image< TPixel, VImageDimension >::ConstWeakPointer

Reimplemented in itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 90 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::DirectionType itk::Image< TPixel, VImageDimension >::DirectionType

Direction typedef support. A matrix of direction cosines.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.

Definition at line 141 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
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::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 132 of file itkImage.h.

template<unsigned int VImageDimension = 2>
typedef IndexType::IndexValueType itk::ImageBase< VImageDimension >::IndexValueType [inherited]

Reimplemented in itk::BloxCoreAtomImage< NDimension >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Definition at line 105 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>
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.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 109 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef PixelType itk::Image< TPixel, VImageDimension >::IOPixelType

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 111 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef NeighborhoodAccessorFunctor< Self > itk::Image< TPixel, VImageDimension >::NeighborhoodAccessorFunctorType

Tyepdef for the functor used to access a neighborhood of pixel pointers.

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >, and itk::SparseImage< TNode, VImageDimension >.

Definition at line 120 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::OffsetType itk::Image< TPixel, VImageDimension >::OffsetType

Offset typedef support. An offset is used to access pixel values.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 135 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::OffsetValueType itk::Image< TPixel, VImageDimension >::OffsetValueType

Offset typedef (relative position between indices)

Reimplemented from itk::ImageBase< VImageDimension >.

Definition at line 159 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef ImportImageContainer<unsigned long, PixelType> itk::Image< TPixel, VImageDimension >::PixelContainer

Container used to store pixels in the image.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 129 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef PixelContainer::ConstPointer itk::Image< TPixel, VImageDimension >::PixelContainerConstPointer

Definition at line 156 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef PixelContainer::Pointer itk::Image< TPixel, VImageDimension >::PixelContainerPointer

A pointer to the pixel container.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 155 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef TPixel itk::Image< TPixel, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 96 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef SmartPointer<Self> itk::Image< TPixel, VImageDimension >::Pointer

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 88 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
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 152 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
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 >.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 144 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Image itk::Image< TPixel, VImageDimension >::Self

Standard class typedefs

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 86 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef Superclass::SizeType itk::Image< TPixel, VImageDimension >::SizeType

Size typedef support. A size is used to define region bounds.

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 138 of file itkImage.h.

template<unsigned int VImageDimension = 2>
typedef SizeType::SizeValueType itk::ImageBase< VImageDimension >::SizeValueType [inherited]

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Definition at line 114 of file itkImageBase.h.

template<class TPixel, unsigned int VImageDimension = 2>
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 >.

Reimplemented in itk::OrientedImage< TPixel, VImageDimension >.

Definition at line 148 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef ImageBase<VImageDimension> itk::Image< TPixel, VImageDimension >::Superclass

Reimplemented from itk::ImageBase< VImageDimension >.

Reimplemented in itk::BloxBoundaryPointImage< TImageDimension >, itk::BloxBoundaryProfileImage< TImageDimension >, itk::BloxCoreAtomImage< NDimension >, itk::BloxImage< TBloxPixelType, TImageDimension >, itk::OrientedImage< TPixel, VImageDimension >, itk::SparseImage< TNode, VImageDimension >, itk::BloxImage< itk::BloxCoreAtomPixel< NDimension >, NDimension >, itk::BloxImage< itk::BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, and itk::BloxImage< itk::BloxBoundaryPointPixel< TImageDimension >, TImageDimension >.

Definition at line 87 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
typedef TPixel itk::Image< TPixel, VImageDimension >::ValueType

Typedef alias for PixelType

Definition at line 103 of file itkImage.h.


Constructor & Destructor Documentation

template<class TPixel, unsigned int VImageDimension = 2>
itk::Image< TPixel, VImageDimension >::Image (  )  [protected]

template<class TPixel, unsigned int VImageDimension = 2>
virtual itk::Image< TPixel, VImageDimension >::~Image (  )  [inline, protected, virtual]

Definition at line 369 of file itkImage.h.


Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [inherited]

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) [inherited]

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

template<class TPixel, unsigned int VImageDimension = 2>
void itk::Image< TPixel, VImageDimension >::Allocate (  ) 

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().

static void itk::LightObject::BreakOnError (  )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<unsigned int VImageDimension = 2>
IndexType itk::ImageBase< VImageDimension >::ComputeIndex ( OffsetValueType  offset  )  const [inline, inherited]

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 in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Definition at line 290 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>
OffsetValueType itk::ImageBase< VImageDimension >::ComputeOffset ( const IndexType ind  )  const [inline, inherited]

Compute an offset from the beginning of the buffer for a pixel at the specified index. The index is not checked as to whether it is inside the current buffer, so the computed offset could conceivably be outside the buffer. If bounds checking is needed, one can call ImageRegion::IsInside(ind) on the BufferedRegion prior to calling ComputeOffset.

Definition at line 255 of file itkImageBase.h.

template<unsigned int VImageDimension = 2>
void itk::ImageBase< VImageDimension >::ComputeOffsetTable (  )  [protected, inherited]

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.

template<unsigned int VImageDimension = 2>
virtual void itk::ImageBase< VImageDimension >::CopyInformation ( const DataObject data  )  [virtual, inherited]

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::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]

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::LightObject.

void itk::DataObject::DataHasBeenGenerated (  )  [inherited]

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

virtual void itk::Object::DebugOff (  )  const [virtual, inherited]

Turn debugging output off.