itk::VTKImageExport< TInputImage > Class Template Reference

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

#include <itkVTKImageExport.h>

Inheritance diagram for itk::VTKImageExport< TInputImage >:

Collaboration diagram for itk::VTKImageExport< TInputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef SmartPointer< Self >	Pointer
typedef VTKImageExport	Self
typedef VTKImageExportBase	Superclass
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)
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 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 ()
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]

---

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.

---

Member Typedef Documentation

template<class TInputImage >

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

Reimplemented from itk::VTKImageExportBase.

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

Reimplemented from itk::VTKImageExportBase.

Definition at line 60 of file itkVTKImageExport.h.

template<class TInputImage >

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

Standard class typedefs.

Reimplemented from itk::VTKImageExportBase.

Definition at line 58 of file itkVTKImageExport.h.

template<class TInputImage >

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

Reimplemented from itk::VTKImageExportBase.

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

(

)

[inline, protected]

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

(

)

[protected, virtual]

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

(

)

[protected, virtual]

Implements itk::VTKImageExportBase.

template<class TInputImage >

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

(

)

[protected, virtual]

Implements itk::VTKImageExportBase.

template<class TInputImage >

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

(

)

[protected, virtual]

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.

Reimplemented from itk::Object.

template<class TInputImage >

int itk::VTKImageExport< TInputImage >::NumberOfComponentsCallback

(

)

[protected, virtual]

Implements itk::VTKImageExportBase.

template<class TInputImage >

void itk::VTKImageExport< TInputImage >::operator=

(

const Self &

)

[private]

Time when GenerateOutputInformation was last called.

Reimplemented from itk::VTKImageExportBase.

template<class TInputImage >

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

(

)

[protected, virtual]

Implements itk::VTKImageExportBase.

template<class TInputImage >

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

template<class TInputImage >

void itk::VTKImageExport< TInputImage >::PropagateUpdateExtentCallback

(

int *

)

[protected, virtual]

Implements itk::VTKImageExportBase.

template<class TInputImage >

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

(

)

[protected, virtual]

Implements itk::VTKImageExportBase.

template<class TInputImage >

void itk::VTKImageExport< TInputImage >::SetInput

(

const InputImageType *

)

template<class TInputImage >

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

(

)

[protected, virtual]

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

(

)

[protected, virtual]

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