itk::VTKImageExport< TInputImage > Class Template Reference

#include <itkVTKImageExport.h>

Inheritance diagram for itk::VTKImageExport< TInputImage >:

Collaboration diagram for itk::VTKImageExport< TInputImage >:

Detailed Description

template<class TInputImage>
class itk::VTKImageExport< TInputImage >

Connect the end of an ITK image pipeline to a VTK pipeline.

VTKImageExport can be used at the end of an ITK image pipeline to connect with a VTK pipeline that begins with vtkImageImport. Callbacks provided by VTKImageExport are registered with vtkImageImport to connect the pipeline execution together. Once connected, update requests coming through the VTK pipeline are automatically propagated to the ITK pipeline.

While VTKImageExportBase provides the pipeline functionality independent of image type, instances must be created through VTKImageExport. This class provides the implementations for callbacks that depend on the image type.

Note that not all image types will work correctly. VTK will only support images of 1, 2, or 3 dimensions. Scalar value types can be one of: float, double, char, unsigned char, short, unsigned short, int, unsigned int, long, unsigned long.

Currently VTKImageExport does not support pixel types with multiple components (like RGBPixel).

See Also

VTKImageExportBase

Definition at line 54 of file itkVTKImageExport.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef SmartPointer< Self >	Pointer
typedef VTKImageExport	Self
typedef VTKImageExportBase	Superclass
Public Types inherited from itk::VTKImageExportBase
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef VTKImageExportBase	Self
typedef ProcessObject	Superclass
typedef void(*	UpdateInformationCallbackType )(void *)
typedef int(*	PipelineModifiedCallbackType )(void *)
typedef int *(*	WholeExtentCallbackType )(void *)
typedef double *(*	SpacingCallbackType )(void *)
typedef double *(*	OriginCallbackType )(void *)
typedef const char *(*	ScalarTypeCallbackType )(void *)
typedef int(*	NumberOfComponentsCallbackType )(void *)
typedef void(*	PropagateUpdateExtentCallbackType )(void *, int *)
typedef void(*	UpdateDataCallbackType )(void *)
typedef int *(*	DataExtentCallbackType )(void *)
typedef void *(*	BufferPointerCallbackType )(void *)
typedef float *(*	FloatSpacingCallbackType )(void *)
typedef float *(*	FloatOriginCallbackType )(void *)
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
	typedef (Concept::SameDimensionOrMinusOneOrTwo< 3, itkGetStaticConstMacro(InputImageDimension) >) ImageDimensionCheck
void	SetInput (const InputImageType *)
InputImageType *	GetInput (void)
Public Member Functions inherited from itk::VTKImageExportBase
BufferPointerCallbackType	GetBufferPointerCallback () const
void *	GetCallbackUserData ()
DataExtentCallbackType	GetDataExtentCallback () const
NumberOfComponentsCallbackType	GetNumberOfComponentsCallback () const
CallbackTypeProxy	GetOriginCallback () const
PipelineModifiedCallbackType	GetPipelineModifiedCallback () const
PropagateUpdateExtentCallbackType	GetPropagateUpdateExtentCallback () const
ScalarTypeCallbackType	GetScalarTypeCallback () const
CallbackTypeProxy	GetSpacingCallback () const
UpdateDataCallbackType	GetUpdateDataCallback () const
UpdateInformationCallbackType	GetUpdateInformationCallback () const
WholeExtentCallbackType	GetWholeExtentCallback () const
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

Protected Types
typedef InputImageType::Pointer	InputImagePointer
typedef InputRegionType::IndexType	InputIndexType
typedef InputImageType::RegionType	InputRegionType
typedef InputRegionType::SizeType	InputSizeType
Protected Types inherited from itk::VTKImageExportBase
typedef DataObject::Pointer	DataObjectPointer

Protected Member Functions
void *	BufferPointerCallback ()
int *	DataExtentCallback ()
float *	FloatOriginCallback ()
float *	FloatSpacingCallback ()
int	NumberOfComponentsCallback ()
double *	OriginCallback ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	PropagateUpdateExtentCallback (int *)
const char *	ScalarTypeCallback ()
double *	SpacingCallback ()
	VTKImageExport ()
int *	WholeExtentCallback ()
	~VTKImageExport ()
Protected Member Functions inherited from itk::VTKImageExportBase
virtual int	PipelineModifiedCallback ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	UpdateDataCallback ()
virtual void	UpdateInformationCallback ()
	VTKImageExportBase ()
	~VTKImageExportBase ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
void	SetRequiredInputNames (const NameArray &)
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
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
void	operator= (const Self &)
	VTKImageExport (const Self &)

Private Attributes
int	m_DataExtent [6]
double	m_DataOrigin [3]
double	m_DataSpacing [3]
float	m_FloatDataOrigin [3]
float	m_FloatDataSpacing [3]
std::string	m_ScalarTypeName
int	m_WholeExtent [6]

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating

Member Typedef Documentation

template<class TInputImage >

typedef SmartPointer< const Self > itk::VTKImageExport< TInputImage >::ConstPointer

Definition at line 61 of file itkVTKImageExport.h.

template<class TInputImage >

typedef InputImageType::Pointer itk::VTKImageExport< TInputImage >::InputImagePointer

protected

Definition at line 90 of file itkVTKImageExport.h.

template<class TInputImage >

typedef TInputImage itk::VTKImageExport< TInputImage >::InputImageType

The type of the input image.

Definition at line 69 of file itkVTKImageExport.h.

template<class TInputImage >

typedef InputRegionType::IndexType itk::VTKImageExport< TInputImage >::InputIndexType

protected

Definition at line 93 of file itkVTKImageExport.h.

template<class TInputImage >

typedef InputImageType::RegionType itk::VTKImageExport< TInputImage >::InputRegionType

protected

Definition at line 91 of file itkVTKImageExport.h.

template<class TInputImage >

typedef InputRegionType::SizeType itk::VTKImageExport< TInputImage >::InputSizeType

protected

Definition at line 92 of file itkVTKImageExport.h.

template<class TInputImage >

typedef SmartPointer< Self > itk::VTKImageExport< TInputImage >::Pointer

Definition at line 60 of file itkVTKImageExport.h.

template<class TInputImage >

typedef VTKImageExport itk::VTKImageExport< TInputImage >::Self

Standard class typedefs.

Definition at line 58 of file itkVTKImageExport.h.

template<class TInputImage >

typedef VTKImageExportBase itk::VTKImageExport< TInputImage >::Superclass

Definition at line 59 of file itkVTKImageExport.h.

Constructor & Destructor Documentation

template<class TInputImage >

itk::VTKImageExport< TInputImage >::VTKImageExport ( )

protected

template<class TInputImage >

itk::VTKImageExport< TInputImage >::~VTKImageExport ( )

inlineprotected

Definition at line 87 of file itkVTKImageExport.h.

template<class TInputImage >

itk::VTKImageExport< TInputImage >::VTKImageExport ( const Self &  )

private

Member Function Documentation

template<class TInputImage >

void* itk::VTKImageExport< TInputImage >::BufferPointerCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

virtual::itk::LightObject::Pointer itk::VTKImageExport< TInputImage >::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.

template<class TInputImage >

int* itk::VTKImageExport< TInputImage >::DataExtentCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

float* itk::VTKImageExport< TInputImage >::FloatOriginCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

float* itk::VTKImageExport< TInputImage >::FloatSpacingCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

InputImageType* itk::VTKImageExport< TInputImage >::GetInput

(

void

)

template<class TInputImage >

virtual const char* itk::VTKImageExport< TInputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::VTKImageExportBase.

template<class TInputImage >

static Pointer itk::VTKImageExport< TInputImage >::New ( )

static

Method for creation through the object factory.

template<class TInputImage >

int itk::VTKImageExport< TInputImage >::NumberOfComponentsCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

void itk::VTKImageExport< TInputImage >::operator= ( const Self &  )

private

template<class TInputImage >

double* itk::VTKImageExport< TInputImage >::OriginCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

void itk::VTKImageExport< TInputImage >::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::ProcessObject.

template<class TInputImage >

void itk::VTKImageExport< TInputImage >::PropagateUpdateExtentCallback ( int *  )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

const char* itk::VTKImageExport< TInputImage >::ScalarTypeCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

void itk::VTKImageExport< TInputImage >::SetInput

(

const InputImageType *

)

template<class TInputImage >

double* itk::VTKImageExport< TInputImage >::SpacingCallback ( )

protectedvirtual

Implements itk::VTKImageExportBase.

template<class TInputImage >

itk::VTKImageExport< TInputImage >::typedef

(

Concept::SameDimensionOrMinusOneOrTwo< 3, itkGetStaticConstMacro(InputImageDimension) >

)

This class requires ImageDimensionCheck in the form of ( Concept::SameDimensionOrMinusOneOrTwo< 3,itkGetStaticConstMacro(InputImageDimension) > )

template<class TInputImage >

int* itk::VTKImageExport< TInputImage >::WholeExtentCallback ( )

protectedvirtual

These callbacks are image-type specific, and are implemented in VTKImageExport.

Implements itk::VTKImageExportBase.

Member Data Documentation

template<class TInputImage >

const unsigned int itk::VTKImageExport< TInputImage >::InputImageDimension = TInputImage::ImageDimension

static

Definition at line 63 of file itkVTKImageExport.h.

template<class TInputImage >

int itk::VTKImageExport< TInputImage >::m_DataExtent[6]

private

Definition at line 121 of file itkVTKImageExport.h.

template<class TInputImage >

double itk::VTKImageExport< TInputImage >::m_DataOrigin[3]

private

Definition at line 123 of file itkVTKImageExport.h.

template<class TInputImage >

double itk::VTKImageExport< TInputImage >::m_DataSpacing[3]

private

Definition at line 122 of file itkVTKImageExport.h.

template<class TInputImage >

float itk::VTKImageExport< TInputImage >::m_FloatDataOrigin[3]

private

Definition at line 125 of file itkVTKImageExport.h.

template<class TInputImage >

float itk::VTKImageExport< TInputImage >::m_FloatDataSpacing[3]

private

Definition at line 124 of file itkVTKImageExport.h.

template<class TInputImage >

std::string itk::VTKImageExport< TInputImage >::m_ScalarTypeName

private

Definition at line 119 of file itkVTKImageExport.h.

template<class TInputImage >

int itk::VTKImageExport< TInputImage >::m_WholeExtent[6]

private

Definition at line 120 of file itkVTKImageExport.h.

---

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

• itkVTKImageExport.h