Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::VTKImageExport< TInputImage, TVTKRealType > 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, TVTKRealType >:

Inheritance graph
[legend]
Collaboration diagram for itk::VTKImageExport< TInputImage, TVTKRealType >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef VTKImageExport Self
typedef VTKImageExportBase Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TVTKRealType vtkRealType
typedef vtkRealType VTKSpacingType
typedef vtkRealType VTKOriginType
typedef TInputImage InputImageType
typedef TVTKRealType *(* SpacingCallbackType )(void *)
typedef TVTKRealType *(* OriginCallbackType )(void *)

Public Member Functions

virtual const char * GetClassName () const
void SetInput (const InputImageType *)
SpacingCallbackType GetSpacingCallback () const
OriginCallbackType GetOriginCallback () const

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)
InputImageTypeGetInput (void)
int * WholeExtentCallback ()
virtual VTKSpacingTypeSpacingCallback ()
virtual VTKOriginTypeOriginCallback ()
const char * ScalarTypeCallback ()
int NumberOfComponentsCallback ()
void PropagateUpdateExtentCallback (int *)
int * DataExtentCallback ()
void * BufferPointerCallback ()

Detailed Description

template<class TInputImage, typename TVTKRealType = float>
class itk::VTKImageExport< TInputImage, TVTKRealType >

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, typename TVTKRealType = float>
typedef SmartPointer<const Self> itk::VTKImageExport< TInputImage, TVTKRealType >::ConstPointer
 

Reimplemented from itk::VTKImageExportBase.

Definition at line 59 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef InputImageType::Pointer itk::VTKImageExport< TInputImage, TVTKRealType >::InputImagePointer [protected]
 

Definition at line 96 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef TInputImage itk::VTKImageExport< TInputImage, TVTKRealType >::InputImageType
 

The type of the input image.

Definition at line 74 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef InputRegionType::IndexType itk::VTKImageExport< TInputImage, TVTKRealType >::InputIndexType [protected]
 

Definition at line 99 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef InputImageType::RegionType itk::VTKImageExport< TInputImage, TVTKRealType >::InputRegionType [protected]
 

Definition at line 97 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef InputRegionType::SizeType itk::VTKImageExport< TInputImage, TVTKRealType >::InputSizeType [protected]
 

Definition at line 98 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef TVTKRealType*(* itk::VTKImageExport< TInputImage, TVTKRealType >::OriginCallbackType)(void*)
 

The function pointer type expected for a callback. These callbacks depend on the "RealType" used by VTK, so they cannot be defined in the superclass.

Definition at line 80 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef SmartPointer<Self> itk::VTKImageExport< TInputImage, TVTKRealType >::Pointer
 

Reimplemented from itk::VTKImageExportBase.

Definition at line 58 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef VTKImageExport itk::VTKImageExport< TInputImage, TVTKRealType >::Self
 

Standard class typedefs.

Reimplemented from itk::VTKImageExportBase.

Definition at line 56 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef TVTKRealType*(* itk::VTKImageExport< TInputImage, TVTKRealType >::SpacingCallbackType)(void*)
 

The function pointer type expected for a callback. These callbacks depend on the "RealType" used by VTK, so they cannot be defined in the superclass.

Definition at line 79 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef VTKImageExportBase itk::VTKImageExport< TInputImage, TVTKRealType >::Superclass
 

Reimplemented from itk::VTKImageExportBase.

Definition at line 57 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef vtkRealType itk::VTKImageExport< TInputImage, TVTKRealType >::VTKOriginType
 

Definition at line 71 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef TVTKRealType itk::VTKImageExport< TInputImage, TVTKRealType >::vtkRealType
 

Typedef for VTK interface. VTK 4.2 uses floats for positions, VTK 4.4 uses doubles.

Definition at line 69 of file itkVTKImageExport.h.

template<class TInputImage, typename TVTKRealType = float>
typedef vtkRealType itk::VTKImageExport< TInputImage, TVTKRealType >::VTKSpacingType
 

Definition at line 70 of file itkVTKImageExport.h.


Constructor & Destructor Documentation

template<class TInputImage, typename TVTKRealType = float>
itk::VTKImageExport< TInputImage, TVTKRealType >::VTKImageExport  )  [protected]
 

template<class TInputImage, typename TVTKRealType = float>
itk::VTKImageExport< TInputImage, TVTKRealType >::~VTKImageExport  )  [inline, protected]
 

Definition at line 93 of file itkVTKImageExport.h.


Member Function Documentation

template<class TInputImage, typename TVTKRealType = float>
void* itk::VTKImageExport< TInputImage, TVTKRealType >::BufferPointerCallback  )  [protected, virtual]
 

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

Implements itk::VTKImageExportBase.

template<class TInputImage, typename TVTKRealType = float>
int* itk::VTKImageExport< TInputImage, TVTKRealType >::DataExtentCallback  )  [protected, virtual]
 

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

Implements itk::VTKImageExportBase.

template<class TInputImage, typename TVTKRealType = float>
virtual const char* itk::VTKImageExport< TInputImage, TVTKRealType >::GetClassName  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::VTKImageExportBase.

template<class TInputImage, typename TVTKRealType = float>
InputImageType* itk::VTKImageExport< TInputImage, TVTKRealType >::GetInput void   )  [protected]
 

template<class TInputImage, typename TVTKRealType = float>
OriginCallbackType itk::VTKImageExport< TInputImage, TVTKRealType >::GetOriginCallback  )  const
 

Get a pointer to function to set as a callback in vtkImageImport.

template<class TInputImage, typename TVTKRealType = float>
SpacingCallbackType itk::VTKImageExport< TInputImage, TVTKRealType >::GetSpacingCallback  )  const
 

Get a pointer to function to set as a callback in vtkImageImport.

template<class TInputImage, typename TVTKRealType = float>
itk::VTKImageExport< TInputImage, TVTKRealType >::itkStaticConstMacro InputImageDimension  ,
unsigned  int,
InputImageType::ImageDimension 
[protected]
 

template<class TInputImage, typename TVTKRealType = float>
Pointer itk::VTKImageExport< TInputImage, TVTKRealType >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage, typename TVTKRealType = float>
int itk::VTKImageExport< TInputImage, TVTKRealType >::NumberOfComponentsCallback  )  [protected, virtual]
 

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

Implements itk::VTKImageExportBase.

template<class TInputImage, typename TVTKRealType = float>
virtual VTKOriginType* itk::VTKImageExport< TInputImage, TVTKRealType >::OriginCallback  )  [protected, virtual]
 

template<class TInputImage, typename TVTKRealType = float>
void itk::VTKImageExport< TInputImage, TVTKRealType >::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, typename TVTKRealType = float>
void itk::VTKImageExport< TInputImage, TVTKRealType >::PropagateUpdateExtentCallback int *   )  [protected, virtual]
 

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

Implements itk::VTKImageExportBase.

template<class TInputImage, typename TVTKRealType = float>
const char* itk::VTKImageExport< TInputImage, TVTKRealType >::ScalarTypeCallback  )  [protected, virtual]
 

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

Implements itk::VTKImageExportBase.

template<class TInputImage, typename TVTKRealType = float>
void itk::VTKImageExport< TInputImage, TVTKRealType >::SetInput const InputImageType  ) 
 

Set the input image of this image exporter.

template<class TInputImage, typename TVTKRealType = float>
virtual VTKSpacingType* itk::VTKImageExport< TInputImage, TVTKRealType >::SpacingCallback  )  [protected, virtual]
 

template<class TInputImage, typename TVTKRealType = float>
int* itk::VTKImageExport< TInputImage, TVTKRealType >::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:
Generated at Sun Jan 25 13:27:08 2004 for ITK by doxygen 1.3.3 written by Dimitri van Heesch, © 1997-2000