ITK  4.3.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Image< TPixel, VImageDimension > Class Template Reference

#include <itkImage.h>

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

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 modelled as arrays, defined by a start index and a size.

The superclass of Image, ImageBase, defines the geometry of the image in terms of where the image sits in physical space, how the image is oriented in physical space, the size of a pixel, and the extent of the image itself. ImageBase provides the methods to convert between the index and physical space coordinate frames.

Pixels can be accessed direcly using the SetPixel() and GetPixel() methods or can be accessed via iterators that define the region of the image they traverse.

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
ImageBase
ImageContainerInterface
Examples:
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 80 of file itkImage.h.

Classes

struct  Rebind
 

Public Types

typedef
DefaultPixelAccessorFunctor
< Self
AccessorFunctorType
 
typedef DefaultPixelAccessor
< PixelType
AccessorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef Superclass::DirectionType DirectionType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef TPixel InternalPixelType
 
typedef PixelType IOPixelType
 
typedef
NeighborhoodAccessorFunctor
< Self
NeighborhoodAccessorFunctorType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::OffsetValueType OffsetValueType
 
typedef ImportImageContainer
< SizeValueType, 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 Superclass::SizeValueType SizeValueType
 
typedef Superclass::SpacingType SpacingType
 
typedef
Superclass::SpacingValueType 
SpacingValueType
 
typedef ImageBase
< VImageDimension > 
Superclass
 
typedef TPixel ValueType
 
- Public Types inherited from itk::ImageBase< VImageDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef Matrix< double,
VImageDimension,
VImageDimension > 
DirectionType
 
typedef Index< VImageDimension > IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef Offset< VImageDimension > OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef SmartPointer< SelfPointer
 
typedef Point< PointValueType,
VImageDimension > 
PointType
 
typedef double PointValueType
 
typedef ImageRegion
< VImageDimension > 
RegionType
 
typedef ImageBase Self
 
typedef Size< VImageDimension > SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef Vector
< SpacingValueType,
VImageDimension > 
SpacingType
 
typedef double SpacingValueType
 
typedef DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void Allocate ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void FillBuffer (const TPixel &value)
 
virtual const char * GetNameOfClass () const
 
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
 
const
NeighborhoodAccessorFunctorType 
GetNeighborhoodAccessor () const
 
virtual unsigned int GetNumberOfComponentsPerPixel () const
 
const TPixel & GetPixel (const IndexType &index) const
 
TPixel & GetPixel (const IndexType &index)
 
AccessorType GetPixelAccessor (void)
 
const AccessorType GetPixelAccessor (void) const
 
PixelContainerGetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
virtual void Graft (const DataObject *data)
 
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)
 
virtual TPixel * GetBufferPointer ()
 
virtual const TPixel * GetBufferPointer () const
 
- Public Member Functions inherited from itk::ImageBase< VImageDimension >
OffsetValueType ComputeOffset (const IndexType &ind) const
 
virtual void CopyInformation (const DataObject *data)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual const DirectionTypeGetDirection ()
 
virtual const DirectionTypeGetInverseDirection ()
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
virtual const PointTypeGetOrigin ()
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const SpacingTypeGetSpacing ()
 
void Initialize ()
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual void SetDirection (const DirectionType direction)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual void SetRegions (const SizeType &size)
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual void SetRequestedRegion (const DataObject *data)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
template<class TCoordRep >
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) 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
 
template<class TCoordRep >
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
virtual void SetOrigin (PointType _arg)
 
virtual void SetOrigin (const double origin[VImageDimension])
 
virtual void SetOrigin (const float origin[VImageDimension])
 
virtual void SetRegions (const RegionType &region)
 
const OffsetValueTypeGetOffsetTable () const
 
IndexType ComputeIndex (OffsetValueType offset) const
 
virtual void SetSpacing (const SpacingType &spacing)
 
virtual void SetSpacing (const double spacing[VImageDimension])
 
virtual void SetSpacing (const float spacing[VImageDimension])
 
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
 
virtual void SetNumberOfComponentsPerPixel (unsigned int)
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag ()
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime ()
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageBase< VImageDimension >
static unsigned int GetImageDimension ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 
- Static Public Attributes inherited from itk::ImageBase< VImageDimension >
static const unsigned int ImageDimension = VImageDimension
 

Protected Member Functions

virtual void ComputeIndexToPhysicalPointMatrices ()
 
 Image ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~Image ()
 
- Protected Member Functions inherited from itk::ImageBase< VImageDimension >
void ComputeOffsetTable ()
 
 ImageBase ()
 
virtual void InitializeBufferedRegion (void)
 
 ~ImageBase ()
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

 Image (const Self &)
 
void operator= (const Self &)
 

Private Attributes

PixelContainerPointer m_Buffer
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ImageBase< VImageDimension >
DirectionType m_Direction
 
DirectionType m_IndexToPhysicalPoint
 
DirectionType m_InverseDirection
 
PointType m_Origin
 
DirectionType m_PhysicalPointToIndex
 
SpacingType m_Spacing
 

Member Typedef Documentation

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

Definition at line 114 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.

Definition at line 113 of file itkImage.h.

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

Definition at line 87 of file itkImage.h.

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

Definition at line 88 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.

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.

Definition at line 127 of file itkImage.h.

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

Definition at line 128 of file itkImage.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.

Definition at line 107 of file itkImage.h.

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

Definition at line 109 of file itkImage.h.

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

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

Definition at line 118 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.

Definition at line 131 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)

Definition at line 161 of file itkImage.h.

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

Container used to store pixels in the image.

Definition at line 138 of file itkImage.h.

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

Definition at line 158 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.

Definition at line 157 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.

Definition at line 94 of file itkImage.h.

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

Definition at line 86 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).

Definition at line 154 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.

Definition at line 145 of file itkImage.h.

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

Standard class typedefs

Definition at line 84 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.

Definition at line 134 of file itkImage.h.

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

Definition at line 135 of file itkImage.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.

Definition at line 149 of file itkImage.h.

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

Definition at line 150 of file itkImage.h.

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

Definition at line 85 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 101 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 ( )
inlineprotectedvirtual

Definition at line 285 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
itk::Image< TPixel, VImageDimension >::Image ( const Self )
private

Member Function Documentation

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

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

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

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

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

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

template<class TPixel, unsigned int VImageDimension = 2>
void itk::Image< TPixel, VImageDimension >::FillBuffer ( const TPixel &  value)

Fill the image buffer with a value. Be sure to call Allocate() first.

template<class TPixel, unsigned int VImageDimension = 2>
virtual TPixel* itk::Image< TPixel, VImageDimension >::GetBufferPointer ( )
inlinevirtual

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

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

Definition at line 234 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
virtual const TPixel* itk::Image< TPixel, VImageDimension >::GetBufferPointer ( ) const
inlinevirtual

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

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

Definition at line 236 of file itkImage.h.

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

template<class TPixel, unsigned int VImageDimension = 2>
NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( )
inline

Return the NeighborhoodAccessor functor

Definition at line 272 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
const NeighborhoodAccessorFunctorType itk::Image< TPixel, VImageDimension >::GetNeighborhoodAccessor ( ) const
inline

Return the NeighborhoodAccessor functor

Definition at line 276 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
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() )
See Also
ImageBase, VectorImage

Returns/Sets the number of components in the image. Note that in the ImageBase implementation, this always returns 1. Image returns the

returned from NumericTraits for the pixel type, and VectorImage

returns the vector length set by the user.

Reimplemented from itk::ImageBase< VImageDimension >.

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

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

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

Return the Pixel Accessor object

Definition at line 264 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
const AccessorType itk::Image< TPixel, VImageDimension >::GetPixelAccessor ( void  ) const
inline

Return the Pixel Accesor object

Definition at line 268 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer ( )
inline

Return a pointer to the container.

Definition at line 241 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
const PixelContainer* itk::Image< TPixel, VImageDimension >::GetPixelContainer ( ) const
inline

Definition at line 244 of file itkImage.h.

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

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

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

Restore the data object to its initial state. This means releasing memory.

Reimplemented from itk::DataObject.

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

template<class TPixel, unsigned int VImageDimension = 2>
static Pointer itk::Image< TPixel, VImageDimension >::New ( )
static
template<class TPixel, unsigned int VImageDimension = 2>
void itk::Image< TPixel, VImageDimension >::operator= ( const Self )
private
template<class TPixel, unsigned int VImageDimension = 2>
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 222 of file itkImage.h.

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

template<class TPixel, unsigned int VImageDimension = 2>
void itk::Image< TPixel, VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageBase< VImageDimension >.

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

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

Set the container to use. Note that this does not cause the DataObject to be modified.

Member Data Documentation

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

Definition at line 124 of file itkImage.h.

template<class TPixel, unsigned int VImageDimension = 2>
PixelContainerPointer itk::Image< TPixel, VImageDimension >::m_Buffer
private

Memory for the current buffer.

Definition at line 299 of file itkImage.h.


The documentation for this class was generated from the following file: