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::ImageAdaptor< TImage, TAccessor > Class Template Reference

#include <itkImageAdaptor.h>

+ Inheritance diagram for itk::ImageAdaptor< TImage, TAccessor >:
+ Collaboration diagram for itk::ImageAdaptor< TImage, TAccessor >:

Detailed Description

template<class TImage, class TAccessor>
class itk::ImageAdaptor< TImage, TAccessor >

Give access to partial aspects of voxels from an Image.

ImageAdaptors are templated over the ImageType and over a functor that will specify what part of the pixel can be accessed

The basic aspects of this class are the types it defines.

Image adaptors can be used as intermediate classes that allow the sending of an image to a filter, specifying what part of the image pixels the filter will act on.

The TAccessor class should implement the Get and Set methods These two will specify how data can be put and get from parts of each pixel. It should define the types ExternalType and InternalType too.

Wiki Examples:

Definition at line 55 of file itkImageAdaptor.h.

Classes

struct  Rebind
 

Public Types

typedef
InternalImageType::AccessorFunctorType::template
Rebind< Self >::Type 
AccessorFunctorType
 
typedef TAccessor AccessorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef Superclass::DirectionType DirectionType
 
typedef Superclass::IndexType IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef TImage InternalImageType
 
typedef InternalPixelTypeInternalPixelPointerType
 
typedef TAccessor::InternalType InternalPixelType
 
typedef PixelType IOPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef TImage::PixelContainer PixelContainer
 
typedef
TImage::PixelContainerConstPointer 
PixelContainerConstPointer
 
typedef
TImage::PixelContainerPointer 
PixelContainerPointer
 
typedef TAccessor::ExternalType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RegionType RegionType
 
typedef ImageAdaptor Self
 
typedef Superclass::SizeType SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef Superclass::SpacingType SpacingType
 
typedef ImageBase
< itkGetStaticConstMacro(ImageDimension) > 
Superclass
 
- Public Types inherited from itk::ImageBase< TImage::ImageDimension >
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 ()
 
IndexType ComputeIndex (OffsetValueType offset) const
 
virtual void CopyInformation (const DataObject *data)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const RegionTypeGetBufferedRegion () const
 
InternalPixelTypeGetBufferPointer ()
 
const InternalPixelTypeGetBufferPointer () const
 
virtual const DirectionTypeGetDirection () const
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const char * GetNameOfClass () const
 
const OffsetValueTypeGetOffsetTable () const
 
virtual const PointTypeGetOrigin () const
 
PixelType GetPixel (const IndexType &index) const
 
AccessorTypeGetPixelAccessor (void)
 
const AccessorTypeGetPixelAccessor (void) const
 
PixelContainerPointer GetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const SpacingTypeGetSpacing () const
 
virtual void Graft (const DataObject *data)
 
virtual void Initialize ()
 
virtual void Modified () const
 
PixelType operator[] (const IndexType &index) const
 
virtual void PropagateRequestedRegion () throw ( InvalidRequestedRegionError )
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual void SetDirection (const DirectionType direction)
 
virtual void SetImage (TImage *)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual void SetOrigin (const PointType values)
 
virtual void SetOrigin (const double *values)
 
virtual void SetOrigin (const float *values)
 
void SetPixel (const IndexType &index, const PixelType &value)
 
void SetPixelAccessor (const AccessorType &accessor)
 
void SetPixelContainer (PixelContainer *container)
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual void SetRequestedRegion (const DataObject *data)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
virtual void SetSpacing (const SpacingType &values)
 
virtual void SetSpacing (const double *values)
 
virtual void SetSpacing (const float *values)
 
template<class TCoordRep >
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &index, Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &point) const
 
template<class TCoordRep >
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &point) const
 
template<class TCoordRep >
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &inputGradient, FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &outputGradient) const
 
template<class TCoordRep >
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &point, ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &index) const
 
template<class TCoordRep >
bool TransformPhysicalPointToIndex (const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &point, IndexType &index) const
 
template<class TCoordRep >
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &inputGradient, FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &outputGradient) const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 
- Public Member Functions inherited from itk::ImageBase< TImage::ImageDimension >
OffsetValueType ComputeOffset (const IndexType &ind) const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const DirectionTypeGetDirection ()
 
virtual const DirectionTypeGetInverseDirection ()
 
virtual const PointTypeGetOrigin ()
 
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)
 
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
 
bool TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
 
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
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])
 
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
 
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
 
virtual unsigned int GetNumberOfComponentsPerPixel () 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 ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
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 const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) 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< TImage::ImageDimension >
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 = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageBase< TImage::ImageDimension >
static const unsigned int ImageDimension
 

Protected Member Functions

 ImageAdaptor ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~ImageAdaptor ()
 
- Protected Member Functions inherited from itk::ImageBase< TImage::ImageDimension >
virtual void ComputeIndexToPhysicalPointMatrices ()
 
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

 ImageAdaptor (const Self &)
 
void operator= (const Self &)
 
template<class TPixelType >
void UpdateAccessor (typename itk::VectorImage< TPixelType, ImageDimension > *)
 
template<class T >
void UpdateAccessor (T *)
 

Private Attributes

TImage::Pointer m_Image
 
AccessorType m_PixelAccessor
 

Additional Inherited Members

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

Member Typedef Documentation

template<class TImage, class TAccessor>
typedef InternalImageType::AccessorFunctorType::template Rebind< Self >::Type itk::ImageAdaptor< TImage, TAccessor >::AccessorFunctorType

typedef of the functor that chooses the appropriate accessor Image or VectorImage.

Definition at line 97 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef TAccessor itk::ImageAdaptor< TImage, TAccessor >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 93 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef SmartPointer< const Self > itk::ImageAdaptor< TImage, TAccessor >::ConstPointer

Definition at line 69 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef WeakPointer< const Self > itk::ImageAdaptor< TImage, TAccessor >::ConstWeakPointer

Definition at line 70 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef Superclass::DirectionType itk::ImageAdaptor< TImage, TAccessor >::DirectionType

Direction typedef support. The Direction is a matix of direction cosines that specify the direction between samples.

Definition at line 126 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef Superclass::IndexType itk::ImageAdaptor< TImage, TAccessor >::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 100 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef IndexType::IndexValueType itk::ImageAdaptor< TImage, TAccessor >::IndexValueType

Definition at line 101 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef TImage itk::ImageAdaptor< TImage, TAccessor >::InternalImageType

Typedef of unadapted image

Definition at line 73 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef InternalPixelType* itk::ImageAdaptor< TImage, TAccessor >::InternalPixelPointerType

Convenient typedef.

Definition at line 248 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef TAccessor::InternalType itk::ImageAdaptor< TImage, TAccessor >::InternalPixelType

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

Definition at line 87 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef PixelType itk::ImageAdaptor< TImage, TAccessor >::IOPixelType

Definition at line 89 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef Superclass::OffsetType itk::ImageAdaptor< TImage, TAccessor >::OffsetType

Offset typedef support.

Definition at line 108 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef OffsetType::OffsetValueType itk::ImageAdaptor< TImage, TAccessor >::OffsetValueType

Definition at line 109 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef TImage::PixelContainer itk::ImageAdaptor< TImage, TAccessor >::PixelContainer

PixelContainer typedef support. Used to construct a container for the pixel data.

Definition at line 220 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef TImage::PixelContainerConstPointer itk::ImageAdaptor< TImage, TAccessor >::PixelContainerConstPointer

Definition at line 222 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef TImage::PixelContainerPointer itk::ImageAdaptor< TImage, TAccessor >::PixelContainerPointer

Definition at line 221 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef TAccessor::ExternalType itk::ImageAdaptor< TImage, TAccessor >::PixelType

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

Definition at line 79 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef SmartPointer< Self > itk::ImageAdaptor< TImage, TAccessor >::Pointer

Definition at line 68 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef Superclass::PointType itk::ImageAdaptor< TImage, TAccessor >::PointType

Origin typedef support. The origin is the geometric coordinates of the index (0,0).

Definition at line 121 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef Superclass::RegionType itk::ImageAdaptor< TImage, TAccessor >::RegionType

Region typedef support. A region is used to specify a subset of an image.

Definition at line 113 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef ImageAdaptor itk::ImageAdaptor< TImage, TAccessor >::Self

Standard class typedefs.

Definition at line 66 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef Superclass::SizeType itk::ImageAdaptor< TImage, TAccessor >::SizeType

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

Definition at line 104 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef SizeType::SizeValueType itk::ImageAdaptor< TImage, TAccessor >::SizeValueType

Definition at line 105 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef Superclass::SpacingType itk::ImageAdaptor< TImage, TAccessor >::SpacingType

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.

Definition at line 117 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
typedef ImageBase< itkGetStaticConstMacro(ImageDimension) > itk::ImageAdaptor< TImage, TAccessor >::Superclass

Definition at line 67 of file itkImageAdaptor.h.

Constructor & Destructor Documentation

template<class TImage, class TAccessor>
itk::ImageAdaptor< TImage, TAccessor >::ImageAdaptor ( )
protected
template<class TImage, class TAccessor>
virtual itk::ImageAdaptor< TImage, TAccessor >::~ImageAdaptor ( )
protectedvirtual
template<class TImage, class TAccessor>
itk::ImageAdaptor< TImage, TAccessor >::ImageAdaptor ( const Self )
private

Member Function Documentation

template<class TImage, class TAccessor>
void itk::ImageAdaptor< TImage, TAccessor >::Allocate ( )
inlinevirtual

Allocate the image memory. Dimension and Size must be set a priori.

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

Definition at line 191 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
IndexType itk::ImageAdaptor< TImage, TAccessor >::ComputeIndex ( OffsetValueType  offset) const

Compute Index given an Offset

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::CopyInformation ( const DataObject data)
virtual

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::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual::itk::LightObject::Pointer itk::ImageAdaptor< TImage, TAccessor >::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::NthElementImageAdaptor< TImage, TOutputPixelType >.

template<class TImage, class TAccessor>
virtual const RegionType& itk::ImageAdaptor< TImage, TAccessor >::GetBufferedRegion ( ) const
virtual

Get the region object that defines the size and starting index of the region of the image currently loaded in memory. This method overloads the one in ImageBase in order to delegate to the adapted image.

See Also
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
InternalPixelType* itk::ImageAdaptor< TImage, TAccessor >::GetBufferPointer ( )

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

template<class TImage, class TAccessor>
const InternalPixelType* itk::ImageAdaptor< TImage, TAccessor >::GetBufferPointer ( ) const
template<class TImage, class TAccessor>
virtual const DirectionType& itk::ImageAdaptor< TImage, TAccessor >::GetDirection ( ) const
virtual

Get the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next. For ImageBase and Image, the default direction is identity.

template<class TImage, class TAccessor>
virtual const RegionType& itk::ImageAdaptor< TImage, TAccessor >::GetLargestPossibleRegion ( ) const
virtual

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. This method overloads the one in ImageBase in order to delegate to the adapted image.

See Also
ImageRegion, GetBufferedRegion(), GetRequestedRegion()

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual ModifiedTimeType itk::ImageAdaptor< TImage, TAccessor >::GetMTime ( ) const
virtual

Delegate GetMTime to the Internal Image

Reimplemented from itk::Object.

template<class TImage, class TAccessor>
virtual const char* itk::ImageAdaptor< TImage, TAccessor >::GetNameOfClass ( ) const
virtual
template<class TImage, class TAccessor>
const OffsetValueType* itk::ImageAdaptor< TImage, TAccessor >::GetOffsetTable ( ) const

Get the OffsetTable from the adapted image

template<class TImage, class TAccessor>
virtual const PointType& itk::ImageAdaptor< TImage, TAccessor >::GetOrigin ( ) const
virtual

Get the origin of the image. The origin is the geometric coordinates of the image origin.

See Also
SetOrigin()
template<class TImage, class TAccessor>
PixelType itk::ImageAdaptor< TImage, TAccessor >::GetPixel ( const IndexType index) const
inline

Get a pixel (read only version)

Definition at line 205 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
AccessorType& itk::ImageAdaptor< TImage, TAccessor >::GetPixelAccessor ( void  )
inline

Return the Data Accesor object

Definition at line 298 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
const AccessorType& itk::ImageAdaptor< TImage, TAccessor >::GetPixelAccessor ( void  ) const
inline

Return the Data Accesor object

Definition at line 302 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
PixelContainerPointer itk::ImageAdaptor< TImage, TAccessor >::GetPixelContainer ( )
inline

Return a pointer to the container.

Definition at line 225 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
const PixelContainer* itk::ImageAdaptor< TImage, TAccessor >::GetPixelContainer ( ) const
inline

Definition at line 228 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
virtual const RegionType& itk::ImageAdaptor< TImage, TAccessor >::GetRequestedRegion ( ) const
virtual

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). This method overloads the one in ImageBase in order to delegate to the adapted image.

See Also
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual const SpacingType& itk::ImageAdaptor< TImage, TAccessor >::GetSpacing ( ) const
virtual

Get the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples.

See Also
SetSpacing()
template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::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< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::Initialize ( )
virtual

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

Reimplemented from itk::DataObject.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::Modified ( ) const
virtual

Delegate Modified to the Internal Image

Reimplemented from itk::Object.

template<class TImage, class TAccessor>
static Pointer itk::ImageAdaptor< TImage, TAccessor >::New ( )
static

Method for creation through the object factory.

template<class TImage, class TAccessor>
void itk::ImageAdaptor< TImage, TAccessor >::operator= ( const Self )
private
template<class TImage, class TAccessor>
PixelType itk::ImageAdaptor< TImage, TAccessor >::operator[] ( const IndexType index) const
inline

Access a pixel. This version can only be an rvalue.

Definition at line 209 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
void itk::ImageAdaptor< TImage, TAccessor >::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< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::PropagateRequestedRegion ( ) throw ( InvalidRequestedRegionError )
virtual

Methods to update the pipeline. Called internally by the pipeline mechanism.

Reimplemented from itk::DataObject.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetBufferedRegion ( const RegionType region)
virtual

Set the region object that defines the size and starting index of the region of the image currently load in memory.

See Also
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()
template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetDirection ( const DirectionType  direction)
virtual

Set the direction of the image.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetImage ( TImage *  )
virtual

Set Internal Image

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetLargestPossibleRegion ( const RegionType region)
virtual

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.

See Also
ImageRegion, SetBufferedRegion(), SetRequestedRegion()
template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin ( const PointType  values)
virtual

Set the origin of the image.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin ( const double *  values)
virtual
template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin ( const float *  values)
virtual
template<class TImage, class TAccessor>
void itk::ImageAdaptor< TImage, TAccessor >::SetPixel ( const IndexType index,
const PixelType value 
)
inline

Set a pixel.

Definition at line 201 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
void itk::ImageAdaptor< TImage, TAccessor >::SetPixelAccessor ( const AccessorType accessor)
inline

Sets the Data Accesor object

Definition at line 306 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
void itk::ImageAdaptor< TImage, TAccessor >::SetPixelContainer ( PixelContainer container)

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

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegion ( const RegionType region)
virtual

Set the region object that defines the size and starting index for the region of the image requested.

See Also
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()
template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegion ( const DataObject data)
virtual

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.

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegionToLargestPossibleRegion ( )
virtual

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

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetSpacing ( const SpacingType values)
virtual

Set the spacing (size of a pixel) of the image.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetSpacing ( const double *  values)
virtual
template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::SetSpacing ( const float *  values)
virtual
template<class TImage, class TAccessor>
template<class TCoordRep >
void itk::ImageAdaptor< TImage, TAccessor >::TransformContinuousIndexToPhysicalPoint ( const ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  index,
Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  point 
) const
inline

Get a physical point (in the space which the origin and spacing information comes from) from a continuous index (in the index space)

See Also
Transform

Definition at line 359 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
template<class TCoordRep >
void itk::ImageAdaptor< TImage, TAccessor >::TransformIndexToPhysicalPoint ( const IndexType index,
Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  point 
) const
inline

Get a physical point (in the space which the origin and spacing information comes from) from a discrete index (in the index space)

See Also
Transform

Definition at line 374 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
template<class TCoordRep >
void itk::ImageAdaptor< TImage, TAccessor >::TransformLocalVectorToPhysicalVector ( const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  inputGradient,
FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  outputGradient 
) const
inline

Definition at line 383 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
template<class TCoordRep >
bool itk::ImageAdaptor< TImage, TAccessor >::TransformPhysicalPointToContinuousIndex ( const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  point,
ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  index 
) const
inline

Get the continuous index from a physical point.

Returns true if the resulting index is within the image, false otherwise.

See Also
Transform

Definition at line 332 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
template<class TCoordRep >
bool itk::ImageAdaptor< TImage, TAccessor >::TransformPhysicalPointToIndex ( const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  point,
IndexType index 
) const
inline

Get the index (discrete) from a physical point. Floating point index results are truncated to integers. Returns true if the resulting index is within the image, false otherwise

See Also
Transform

Definition at line 346 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
template<class TCoordRep >
void itk::ImageAdaptor< TImage, TAccessor >::TransformPhysicalVectorToLocalVector ( const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  inputGradient,
FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  outputGradient 
) const
inline

Definition at line 391 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::Update ( )
virtual

Return the Data Accesor object

Reimplemented from itk::DataObject.

template<class TImage, class TAccessor>
template<class TPixelType >
void itk::ImageAdaptor< TImage, TAccessor >::UpdateAccessor ( typename itk::VectorImage< TPixelType, ImageDimension > *  )
inlineprivate

Definition at line 412 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
template<class T >
void itk::ImageAdaptor< TImage, TAccessor >::UpdateAccessor ( T *  )
inlineprivate

Definition at line 418 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::UpdateOutputData ( )
virtual

UpdateOutputData() is part of the pipeline infrastructure to communicate between ProcessObjects and DataObjects. The method of the superclass is overriden to check if the requested image region has zero pixels. This is needed so that filters can set an input's requested region to zero, to indicate that it does not need to be updated or executed.

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual void itk::ImageAdaptor< TImage, TAccessor >::UpdateOutputInformation ( )
virtual

Methods to update the pipeline. Called internally by the pipeline mechanism.

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

template<class TImage, class TAccessor>
virtual bool itk::ImageAdaptor< TImage, TAccessor >::VerifyRequestedRegion ( )
virtual

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.

Reimplemented from itk::ImageBase< TImage::ImageDimension >.

Member Data Documentation

template<class TImage, class TAccessor>
const unsigned int itk::ImageAdaptor< TImage, TAccessor >::ImageDimension = TImage::ImageDimension
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 63 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
TImage::Pointer itk::ImageAdaptor< TImage, TAccessor >::m_Image
private

Definition at line 422 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>
AccessorType itk::ImageAdaptor< TImage, TAccessor >::m_PixelAccessor
private

Definition at line 426 of file itkImageAdaptor.h.


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