Give access to partial aspects of voxels from an Image. More...

#include <itkImageAdaptor.h>

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

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

Public Types
typedef DefaultPixelAccessorFunctor < Self >	AccessorFunctorType
typedef TAccessor	AccessorType
typedef SmartPointer< const Self >	ConstPointer
typedef WeakPointer< const Self >	ConstWeakPointer
typedef Superclass::DirectionType	DirectionType
typedef Superclass::IndexType	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef TImage	InternalImageType
typedef InternalPixelType *	InternalPixelPointerType
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< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	PointValueType
typedef Superclass::RegionType	RegionType
typedef ImageAdaptor	Self
typedef Superclass::SizeType	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef Superclass::SpacingType	SpacingType
typedef double	SpacingValueType
typedef ImageBase < itkGetStaticConstMacro(ImageDimension)>	Superclass
Public Member Functions
void	Allocate ()
IndexType	ComputeIndex (OffsetValueType offset) const
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 ()
virtual const RegionType &	GetBufferedRegion () const
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
virtual const DirectionType &	GetDirection ()
virtual const DirectionType &	GetDirection () const
virtual const RegionType &	GetLargestPossibleRegion () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
const OffsetValueType *	GetOffsetTable () const
virtual const PointType &	GetOrigin ()
virtual const PointType &	GetOrigin () const
PixelType	GetPixel (const IndexType &index) const
AccessorType &	GetPixelAccessor (void)
const AccessorType &	GetPixelAccessor (void) const
PixelContainerPointer	GetPixelContainer ()
const PixelContainer *	GetPixelContainer () const
virtual int	GetReferenceCount () const
virtual const RegionType &	GetRequestedRegion () const
SmartPointerForwardReference < ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual const SpacingType &	GetSpacing ()
virtual const SpacingType &	GetSpacing () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Graft (const DataObject *data)
bool	HasObserver (const EventObject &event) const
virtual void	Initialize ()
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
PixelType	operator[] (const IndexType &index) const
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 bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
virtual void	SetBufferedRegion (const RegionType &region)
virtual void	SetBufferedRegion (const RegionType &region)
void	SetDebug (bool debugFlag) const
virtual void	SetDirection (const DirectionType direction)
virtual void	SetDirection (const DirectionType direction)
virtual void	SetImage (TImage *)
virtual void	SetLargestPossibleRegion (const RegionType &region)
virtual void	SetLargestPossibleRegion (const RegionType &region)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetPixel (const IndexType &index, const PixelType &value)
void	SetPixelAccessor (const AccessorType &accessor)
void	SetPixelContainer (PixelContainer *container)
virtual void	SetReferenceCount (int)
virtual void	SetRequestedRegion (DataObject *data)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const RegionType &region)
bool	ShouldIReleaseData () const
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
bool	TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
template<class TCoordRep >
bool	TransformPhysicalPointToIndex (const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &point, IndexType &index) const
virtual void	UnRegister () const


InternalPixelType *	GetBufferPointer ()
const InternalPixelType *	GetBufferPointer () const


virtual void	SetSpacing (const SpacingType &values)
virtual void	SetSpacing (const double *values)
virtual void	SetSpacing (const float *values)


virtual void	SetOrigin (const PointType values)
virtual void	SetOrigin (const double *values)
virtual void	SetOrigin (const float *values)


virtual void	Update ()
virtual void	CopyInformation (const DataObject *data)


virtual void	UpdateOutputInformation ()
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	UpdateOutputData ()
virtual bool	VerifyRequestedRegion ()


virtual void	SetOrigin (PointType _arg)
virtual void	SetOrigin (const double origin[VImageDimension])
virtual void	SetOrigin (const float origin[VImageDimension])


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


void	TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const


virtual unsigned int	GetNumberOfComponentsPerPixel () const
virtual void	SetNumberOfComponentsPerPixel (unsigned int)


void	SetReleaseDataFlag (bool flag)
virtual const bool &	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOn ()
virtual void	ReleaseDataFlagOff ()


void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static unsigned int	GetImageDimension ()
static Pointer	New ()


static void	SetGlobalReleaseDataFlag (bool val)
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOn ()
static void	GlobalReleaseDataFlagOff ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	ImageDimension = TImage::ImageDimension
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	ComputeIndexToPhysicalPointMatrices ()
void	ComputeOffsetTable ()
	ImageAdaptor ()
virtual void	InitializeBufferedRegion (void)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual	~ImageAdaptor ()


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
DirectionType	m_Direction
DirectionType	m_IndexToPhysicalPoint
PointType	m_Origin
DirectionType	m_PhysicalPointToIndex
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
SpacingType	m_Spacing

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.

Definition at line 48 of file itkImageAdaptor.h.

Member Typedef Documentation

template<class TImage, class TAccessor>

typedef DefaultPixelAccessorFunctor< Self > itk::ImageAdaptor< TImage, TAccessor >::AccessorFunctorType

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

Definition at line 90 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 86 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

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

Definition at line 62 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

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

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

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

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

Definition at line 93 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

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

Definition at line 94 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

Typedef of unadapted image

Definition at line 66 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

Convenient typedef.

Definition at line 229 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 80 of file itkImageAdaptor.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TImage, class TAccessor>

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

Reimplemented in itk::VectorImageToImageAdaptor< TPixelType, Dimension >.

Definition at line 82 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

Offset typedef support.

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

Definition at line 101 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

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

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

Reimplemented in itk::RGBToVectorImageAdaptor< TImage >, itk::VectorImageToImageAdaptor< TPixelType, Dimension >, and itk::VectorToRGBImageAdaptor< TImage >.

Definition at line 201 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

Reimplemented in itk::RGBToVectorImageAdaptor< TImage >, itk::VectorImageToImageAdaptor< TPixelType, Dimension >, and itk::VectorToRGBImageAdaptor< TImage >.

Definition at line 203 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

Reimplemented in itk::RGBToVectorImageAdaptor< TImage >, itk::VectorImageToImageAdaptor< TPixelType, Dimension >, and itk::VectorToRGBImageAdaptor< TImage >.

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

Reimplemented in itk::AddImageAdaptor< TImage >.

Definition at line 72 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

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

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

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

Definition at line 114 of file itkImageAdaptor.h.

typedef double itk::ImageBase< VImageDimension >::PointValueType [inherited]

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

Definition at line 133 of file itkImageBase.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.

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

Definition at line 106 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

Standard class typedefs.

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

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

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

Definition at line 97 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

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

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

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

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

Definition at line 110 of file itkImageAdaptor.h.

typedef double itk::ImageBase< VImageDimension >::SpacingValueType [inherited]

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. ITK only supports positive spacing value: negative values may cause undesirable results.

Definition at line 128 of file itkImageBase.h.

template<class TImage, class TAccessor>

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

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

Definition at line 60 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 ( ) [protected, virtual]

Member Function Documentation

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[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 TImage, class TAccessor>

void itk::ImageAdaptor< TImage, TAccessor >::Allocate ( ) [inline, virtual]

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

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

Definition at line 171 of file itkImageAdaptor.h.

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

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

template<class TImage, class TAccessor>

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

Compute Index given an Offset

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

Definition at line 331 of file itkImageBase.h.

virtual void itk::ImageBase< VImageDimension >::ComputeIndexToPhysicalPointMatrices ( ) [protected, virtual, inherited]

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.

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 295 of file itkImageBase.h.

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<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::CopyInformation ( const DataObject * data ) [virtual]

Return the Data Accesor object

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

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.

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

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

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< ::itk::GetImageDimension< 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

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

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::DataObject::GetDataReleased ( ) const [inline, inherited]

Get the flag indicating the data has been released.

Definition at line 334 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

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.

virtual const DirectionType& itk::ImageBase< VImageDimension >::GetDirection ( void ) [virtual, inherited]

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.

static bool itk::DataObject::GetGlobalReleaseDataFlag ( ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

static unsigned int itk::ImageBase< VImageDimension >::GetImageDimension ( ) [inline, static, inherited]

Image dimension. The dimension of an image is fixed at construction.

Definition at line 145 of file itkImageBase.h.

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

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

template<class TImage, class TAccessor>

virtual unsigned long 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]

Run-time type information (and related methods).

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

virtual unsigned int itk::ImageBase< VImageDimension >::GetNumberOfComponentsPerPixel ( ) const [virtual, inherited]

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 for all images this is 1. Even for Image< RGBPixel< T >, 3 >. This is >= 1 only for time-series images such as itk::VectorImage.

template<class TImage, class TAccessor>

const OffsetValueType* itk::ImageAdaptor< TImage, TAccessor >::GetOffsetTable ( ) const

Get the OffsetTable from the adapted image

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

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

virtual const PointType& itk::ImageBase< VImageDimension >::GetOrigin ( void ) [virtual, inherited]

Get the origin of the image. The origin is the geometric coordinates of the index (0,0). The value returned is a pointer to a double array. For ImageBase and Image, the default origin is 0.

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( ) [virtual, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

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 186 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 277 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 281 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 206 of file itkImageAdaptor.h.

template<class TImage, class TAccessor>

const PixelContainer* itk::ImageAdaptor< TImage, TAccessor >::GetPixelContainer ( ) const [inline]

Definition at line 209 of file itkImageAdaptor.h.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

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

SmartPointerForwardReference<ProcessObject> itk::DataObject::GetSource ( ) const [inherited]

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const [inherited]

Which of the source's outputs corresponds to this data object?

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

virtual const SpacingType& itk::ImageBase< VImageDimension >::GetSpacing ( void ) [virtual, inherited]

Get the spacing (size of a pixel) `of the image. The spacing is the geometric distance between image samples. The value returned is a pointer to a double array. For ImageBase and Image, the default data spacing is unity.

virtual unsigned long itk::DataObject::GetUpdateMTime ( ) const [virtual, inherited]

MTime for the last time this DataObject was generated.

static void itk::DataObject::GlobalReleaseDataFlagOff ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 319 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( ) [inline, static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 317 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

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

virtual void itk::ImageBase< VImageDimension >::InitializeBufferedRegion ( void ) [protected, virtual, inherited]

Restores the buffered region to it's default state This method does not call Modify because Initialization is called by ReleaseData and can not modify the MTime

See also:: ReleaseData, Initialize, SetBufferedRegion

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

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.

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

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 190 of file itkImageAdaptor.h.

virtual void itk::DataObject::PrepareForNewData ( ) [inline, virtual, inherited]

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 389 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TImage, class TAccessor>

void itk::ImageAdaptor< TImage, TAccessor >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

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.

virtual void itk::DataObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Propagate a call to ResetPipeline(). Called only from ProcessObject.

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

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

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

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

virtual void itk::DataObject::ReleaseDataFlagOff ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

virtual void itk::DataObject::ReleaseDataFlagOn ( ) [virtual, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual bool itk::ImageBase< VImageDimension >::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [virtual, inherited]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented from itk::DataObject.

virtual void itk::DataObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

virtual void itk::ImageBase< VImageDimension >::SetBufferedRegion ( const RegionType & region ) [virtual, inherited]

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

See also:: ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

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

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::SetDirection ( const DirectionType direction ) [virtual]

Set the direction of the image.

virtual void itk::ImageBase< VImageDimension >::SetDirection ( const DirectionType direction ) [virtual, inherited]

Set the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next.

One row of the matrix indicates the direction cosines of the unit vector that is parallel to the lines of the image grid corresponding to that dimension. For example, and image with Direction matrix

0.866 0.500 -0.500 0.866

has an image grid were the fastest changing index (dimension[0]) walks over a line that in Physical space is oriented parallel to the vector (0.866,0.5). The second fastest changing index (dimension[1]) walks along a line that in Physical space is oriented parallel to the vector (-0.5,0.866)

The vectors whose direction cosines are stored in the Direction matrix, are expected to be orthogonal to each other, and they are expected to form a right handed coordinate system, but this is not checked nor enforced in the itk::ImageBase.

For details, please see:

http://www.itk.org/Wiki/Proposals:Orientation#Some_notes_on_the_DICOM_convention_and_current_ITK_usage

See also:: GetDirection()

static void itk::DataObject::SetGlobalReleaseDataFlag ( bool val ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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

virtual void itk::ImageBase< VImageDimension >::SetLargestPossibleRegion ( const RegionType & region ) [virtual, inherited]

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::ImageBase< VImageDimension >::SetNumberOfComponentsPerPixel ( unsigned int ) [virtual, inherited]

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 for all images this is 1. Even for Image< RGBPixel< T >, 3 >. This is >= 1 only for time-series images such as itk::VectorImage.

virtual void itk::ImageBase< VImageDimension >::SetOrigin ( const float origin[VImageDimension] ) [virtual, inherited]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

template<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin ( const float * values ) [virtual]

Set the origin of the image.

template<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin ( const double * values ) [virtual]

Set the origin of the image.

virtual void itk::ImageBase< VImageDimension >::SetOrigin ( const double origin[VImageDimension] ) [virtual, inherited]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

template<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::SetOrigin ( const PointType values ) [virtual]

Set the origin of the image.

virtual void itk::ImageBase< VImageDimension >::SetOrigin ( PointType _arg ) [virtual, inherited]

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See also:: GetOrigin()

void itk::DataObject::SetPipelineMTime ( unsigned long time ) [inline, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 373 of file itkDataObject.h.

template<class TImage, class TAccessor>

void itk::ImageAdaptor< TImage, TAccessor >::SetPixel	(	const IndexType &	index,
		const PixelType &	value
	)			`[inline]`

Set a pixel.

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

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

void itk::DataObject::SetReleaseDataFlag ( bool flag ) [inline, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

template<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegion ( 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< ::itk::GetImageDimension< TImage >::ImageDimension >.

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

virtual void itk::ImageBase< VImageDimension >::SetRequestedRegion ( const RegionType & region ) [virtual, inherited]

Set the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation.

See also:: ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

template<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::SetRequestedRegionToLargestPossibleRegion ( ) [virtual]

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

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< 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.

virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const double spacing[VImageDimension] ) [virtual, 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()).

virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const SpacingType & spacing ) [virtual, inherited]

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float. These methods also pre-compute the Index to Physical point transforms of the image.

See also:: GetSpacing()

template<class TImage, class TAccessor>

virtual void itk::ImageAdaptor< TImage, TAccessor >::SetSpacing ( const float * 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]

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

virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const float spacing[VImageDimension] ) [virtual, 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()).

bool itk::DataObject::ShouldIReleaseData ( ) const [inherited]

Return flag indicating whether data should be released after use by a filter.

void itk::ImageBase< VImageDimension >::TransformContinuousIndexToPhysicalPoint	(	const ContinuousIndex< TCoordRep, VImageDimension > &	index,
		Point< TCoordRep, VImageDimension > &	point
	)			const `[inline, inherited]`

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

See also:: Transform

Definition at line 440 of file itkImageBase.h.

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 infomation comes from) from a continuous index (in the index space)

See also:: Transform

Definition at line 334 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 infomation comes from) from a discrete index (in the index space)

See also:: Transform

Definition at line 349 of file itkImageAdaptor.h.

void itk::ImageBase< VImageDimension >::TransformIndexToPhysicalPoint	(	const IndexType &	index,
		Point< TCoordRep, VImageDimension > &	point
	)			const `[inline, inherited]`

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

See also:: Transform

Definition at line 472 of file itkImageBase.h.

void itk::ImageBase< VImageDimension >::TransformLocalVectorToPhysicalVector	(	const FixedArray< TCoordRep, VImageDimension > &	inputGradient,
		FixedArray< TCoordRep, VImageDimension > &	outputGradient
	)			const `[inline, inherited]`

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

See also:: Transform Take a vector or covariant vector that has been computed in the coordinate system parallel to the image grid and rotate it by the direction cosines in order to get it in terms of the coordinate system of the image acquisition device. This implementation in the OrientedImage multiply the array (vector or covariant vector) by the matrix of Direction Cosines. The arguments of the method are of type FixedArray to make possible to use this method with both Vector and CovariantVector. The Method is implemented differently in the itk::Image.; Image

Definition at line 507 of file itkImageBase.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 358 of file itkImageAdaptor.h.

bool itk::ImageBase< VImageDimension >::TransformPhysicalPointToContinuousIndex	(	const Point< TCoordRep, VImageDimension > &	point,
		ContinuousIndex< TCoordRep, VImageDimension > &	index
	)			const `[inline, inherited]`

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 412 of file itkImageBase.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 307 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 321 of file itkImageAdaptor.h.

bool itk::ImageBase< VImageDimension >::TransformPhysicalPointToIndex	(	const Point< TCoordRep, VImageDimension > &	point,
		IndexType &	index
	)			const `[inline, inherited]`

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

See also:: Transform

Definition at line 382 of file itkImageBase.h.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

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>

virtual void itk::ImageAdaptor< TImage, TAccessor >::UpdateOutputData ( ) [virtual]

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

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< 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< ::itk::GetImageDimension< TImage >::ImageDimension >.

template<class TImage, class TAccessor>

virtual bool itk::ImageAdaptor< TImage, TAccessor >::VerifyRequestedRegion ( ) [virtual]

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

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< 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.

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

Definition at line 56 of file itkImageAdaptor.h.

DirectionType itk::ImageBase< VImageDimension >::m_Direction [protected, inherited]

Definition at line 646 of file itkImageBase.h.

DirectionType itk::ImageBase< VImageDimension >::m_IndexToPhysicalPoint [protected, inherited]

Matrices intended to help with the conversion of Index coordinates to PhysicalPoint coordinates

Definition at line 650 of file itkImageBase.h.

PointType itk::ImageBase< VImageDimension >::m_Origin [protected, inherited]

Definition at line 645 of file itkImageBase.h.

DirectionType itk::ImageBase< VImageDimension >::m_PhysicalPointToIndex [protected, inherited]

Definition at line 651 of file itkImageBase.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

SpacingType itk::ImageBase< VImageDimension >::m_Spacing [protected, inherited]

Origin and spacing of physical coordinates. This variables are protected for efficiency. They are referenced frequently by inner loop calculations.

Definition at line 644 of file itkImageBase.h.

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

itkImageAdaptor.h

itk::ImageAdaptor< TImage, TAccessor > Class Template Reference [Image Adaptors]

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ImageAdaptor< TImage, TAccessor > Class Template Reference
[Image Adaptors]

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