itk::VTKImageExport< TInputImage > Class Template Reference
[Input and Output Filters]

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

#include <itkVTKImageExport.h>

Inheritance diagram for itk::VTKImageExport< TInputImage >:

[legend]Collaboration diagram for itk::VTKImageExport< TInputImage >:

[legend]List of all members.

Public Types
typedef VTKImageExport	Self
typedef VTKImageExportBase	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
Public Member Functions
virtual const char *	GetClassName () const
void	SetInput (const InputImageType *)
Static Public Member Functions
Pointer	New ()
Protected Types
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputRegionType
typedef InputRegionType::SizeType	InputSizeType
typedef InputRegionType::IndexType	InputIndexType
Protected Member Functions
	VTKImageExport ()
	~VTKImageExport ()
void	PrintSelf (std::ostream &os, Indent indent) const
	itkStaticConstMacro (InputImageDimension, unsigned int, InputImageType::ImageDimension)
InputImageType *	GetInput (void)
int *	WholeExtentCallback ()
double *	SpacingCallback ()
double *	OriginCallback ()
float *	FloatSpacingCallback ()
float *	FloatOriginCallback ()
const char *	ScalarTypeCallback ()
int	NumberOfComponentsCallback ()
void	PropagateUpdateExtentCallback (int *)
int *	DataExtentCallback ()
void *	BufferPointerCallback ()

---

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 52 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 59 of file itkVTKImageExport.h.

template<class TInputImage> typedef InputImageType::Pointer itk::VTKImageExport< TInputImage >::InputImagePointer [protected]

Definition at line 78 of file itkVTKImageExport.h.

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

The type of the input image. Definition at line 68 of file itkVTKImageExport.h.

template<class TInputImage> typedef InputRegionType::IndexType itk::VTKImageExport< TInputImage >::InputIndexType [protected]

Definition at line 81 of file itkVTKImageExport.h.

template<class TInputImage> typedef InputImageType::RegionType itk::VTKImageExport< TInputImage >::InputRegionType [protected]

Definition at line 79 of file itkVTKImageExport.h.

template<class TInputImage> typedef InputRegionType::SizeType itk::VTKImageExport< TInputImage >::InputSizeType [protected]

Definition at line 80 of file itkVTKImageExport.h.

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

Reimplemented from itk::VTKImageExportBase. Definition at line 58 of file itkVTKImageExport.h.

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

Standard class typedefs. Reimplemented from itk::VTKImageExportBase. Definition at line 56 of file itkVTKImageExport.h.

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

Reimplemented from itk::VTKImageExportBase. Definition at line 57 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 75 of file itkVTKImageExport.h.

---

Member Function Documentation

template<class TInputImage> void* itk::VTKImageExport< TInputImage >::BufferPointerCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> int* itk::VTKImageExport< TInputImage >::DataExtentCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> float* itk::VTKImageExport< TInputImage >::FloatOriginCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> float* itk::VTKImageExport< TInputImage >::FloatSpacingCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> virtual const char* itk::VTKImageExport< TInputImage >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::VTKImageExportBase.

template<class TInputImage> InputImageType* itk::VTKImageExport< TInputImage >::GetInput (  void   )  [protected]

template<class TInputImage> itk::VTKImageExport< TInputImage >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, InputImageType::ImageDimension  )  [protected]

template<class TInputImage> 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]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> double* itk::VTKImageExport< TInputImage >::OriginCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. 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]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> const char* itk::VTKImageExport< TInputImage >::ScalarTypeCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> void itk::VTKImageExport< TInputImage >::SetInput (  const InputImageType *   )

Set the input image of this image exporter.

template<class TInputImage> double* itk::VTKImageExport< TInputImage >::SpacingCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

template<class TInputImage> int* itk::VTKImageExport< TInputImage >::WholeExtentCallback (   )  [protected, virtual]

These callbacks are image-type specific, and are implemented in VTKImageExport. Implements itk::VTKImageExportBase.

---

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

• itkVTKImageExport.h

---