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

itk::VTKImageImport< TOutputImage, TVTKRealType > Class Template Reference
[Input and Output Filters]

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

#include <itkVTKImageImport.h>

Inheritance diagram for itk::VTKImageImport< TOutputImage, TVTKRealType >:

Inheritance graph
[legend]
Collaboration diagram for itk::VTKImageImport< TOutputImage, TVTKRealType >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef VTKImageImport Self
typedef ImageSource< TOutputImage > Superclass
typedef SmartPointer< SelfPointer
typedef TVTKRealType vtkRealType
typedef TOutputImage OutputImageType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::PixelType OutputPixelType
typedef OutputImageType::SizeType OutputSizeType
typedef OutputImageType::IndexType OutputIndexType
typedef OutputImageType::RegionType OutputRegionType
typedef vtkRealType VTKSpacingType
typedef vtkRealType VTKOriginType
typedef void(* UpdateInformationCallbackType )(void *)
typedef int(* PipelineModifiedCallbackType )(void *)
typedef int *(* WholeExtentCallbackType )(void *)
typedef VTKSpacingType *(* SpacingCallbackType )(void *)
typedef VTKOriginType *(* 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 *)

Public Member Functions

virtual const char * GetClassName () const
 itkStaticConstMacro (OutputImageDimension, unsigned int, OutputImageType::ImageDimension)
virtual void SetUpdateInformationCallback (UpdateInformationCallbackType _arg)
virtual UpdateInformationCallbackType GetUpdateInformationCallback ()
virtual void SetPipelineModifiedCallback (PipelineModifiedCallbackType _arg)
virtual PipelineModifiedCallbackType GetPipelineModifiedCallback ()
virtual void SetWholeExtentCallback (WholeExtentCallbackType _arg)
virtual WholeExtentCallbackType GetWholeExtentCallback ()
virtual void SetSpacingCallback (SpacingCallbackType _arg)
virtual SpacingCallbackType GetSpacingCallback ()
virtual void SetOriginCallback (OriginCallbackType _arg)
virtual OriginCallbackType GetOriginCallback ()
virtual void SetScalarTypeCallback (ScalarTypeCallbackType _arg)
virtual ScalarTypeCallbackType GetScalarTypeCallback ()
virtual void SetNumberOfComponentsCallback (NumberOfComponentsCallbackType _arg)
virtual NumberOfComponentsCallbackType GetNumberOfComponentsCallback ()
virtual void SetPropagateUpdateExtentCallback (PropagateUpdateExtentCallbackType _arg)
virtual PropagateUpdateExtentCallbackType GetPropagateUpdateExtentCallback ()
virtual void SetUpdateDataCallback (UpdateDataCallbackType _arg)
virtual UpdateDataCallbackType GetUpdateDataCallback ()
virtual void SetDataExtentCallback (DataExtentCallbackType _arg)
virtual DataExtentCallbackType GetDataExtentCallback ()
virtual void SetBufferPointerCallback (BufferPointerCallbackType _arg)
virtual BufferPointerCallbackType GetBufferPointerCallback ()
 itkSetMacro2 (CallbackUserData, void *)
virtual void * GetCallbackUserData ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 VTKImageImport ()
 ~VTKImageImport ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PropagateRequestedRegion (DataObject *)
virtual void UpdateOutputInformation ()
virtual void GenerateData ()
virtual void GenerateOutputInformation ()

Detailed Description

template<typename TOutputImage, typename TVTKRealType = float>
class itk::VTKImageImport< TOutputImage, TVTKRealType >

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

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

Note that the VTK images are assumed to be 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. The images must have pixel types with one component.

See also:
VTKImageImport

Definition at line 55 of file itkVTKImageImport.h.


Member Typedef Documentation

template<typename TOutputImage, typename TVTKRealType = float>
typedef void*(* itk::VTKImageImport< TOutputImage, TVTKRealType >::BufferPointerCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 105 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef int*(* itk::VTKImageImport< TOutputImage, TVTKRealType >::DataExtentCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 104 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef int(* itk::VTKImageImport< TOutputImage, TVTKRealType >::NumberOfComponentsCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 101 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef VTKOriginType*(* itk::VTKImageImport< TOutputImage, TVTKRealType >::OriginCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 99 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef OutputImageType::Pointer itk::VTKImageImport< TOutputImage, TVTKRealType >::OutputImagePointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 75 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef TOutputImage itk::VTKImageImport< TOutputImage, TVTKRealType >::OutputImageType
 

Convenient typedefs from the output image.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 74 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef OutputImageType::IndexType itk::VTKImageImport< TOutputImage, TVTKRealType >::OutputIndexType
 

Definition at line 78 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef OutputImageType::PixelType itk::VTKImageImport< TOutputImage, TVTKRealType >::OutputPixelType
 

Definition at line 76 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef OutputImageType::RegionType itk::VTKImageImport< TOutputImage, TVTKRealType >::OutputRegionType
 

Definition at line 79 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef OutputImageType::SizeType itk::VTKImageImport< TOutputImage, TVTKRealType >::OutputSizeType
 

Definition at line 77 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef int(* itk::VTKImageImport< TOutputImage, TVTKRealType >::PipelineModifiedCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 96 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef SmartPointer<Self> itk::VTKImageImport< TOutputImage, TVTKRealType >::Pointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 61 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef void(* itk::VTKImageImport< TOutputImage, TVTKRealType >::PropagateUpdateExtentCallbackType)(void*, int*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 102 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef const char*(* itk::VTKImageImport< TOutputImage, TVTKRealType >::ScalarTypeCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 100 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef VTKImageImport itk::VTKImageImport< TOutputImage, TVTKRealType >::Self
 

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 59 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef VTKSpacingType*(* itk::VTKImageImport< TOutputImage, TVTKRealType >::SpacingCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 98 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef ImageSource<TOutputImage> itk::VTKImageImport< TOutputImage, TVTKRealType >::Superclass
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 60 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef void(* itk::VTKImageImport< TOutputImage, TVTKRealType >::UpdateDataCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 103 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef void(* itk::VTKImageImport< TOutputImage, TVTKRealType >::UpdateInformationCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 95 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef vtkRealType itk::VTKImageImport< TOutputImage, TVTKRealType >::VTKOriginType
 

Definition at line 84 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef TVTKRealType itk::VTKImageImport< TOutputImage, TVTKRealType >::vtkRealType
 

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

Definition at line 71 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef vtkRealType itk::VTKImageImport< TOutputImage, TVTKRealType >::VTKSpacingType
 

VTK 4.2 uses float for representing origin and spacing after version 4.2 the types switched to double.

Definition at line 83 of file itkVTKImageImport.h.

template<typename TOutputImage, typename TVTKRealType = float>
typedef int*(* itk::VTKImageImport< TOutputImage, TVTKRealType >::WholeExtentCallbackType)(void*)
 

These are function pointer types for the pipeline connection callbacks.

Definition at line 97 of file itkVTKImageImport.h.


Constructor & Destructor Documentation

template<typename TOutputImage, typename TVTKRealType = float>
itk::VTKImageImport< TOutputImage, TVTKRealType >::VTKImageImport  )  [protected]
 

template<typename TOutputImage, typename TVTKRealType = float>
itk::VTKImageImport< TOutputImage, TVTKRealType >::~VTKImageImport  )  [inline, protected]
 

Definition at line 170 of file itkVTKImageImport.h.


Member Function Documentation

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::GenerateData  )  [protected, virtual]
 

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::GenerateOutputInformation  )  [protected, virtual]
 

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

template<typename TOutputImage, typename TVTKRealType = float>
virtual BufferPointerCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetBufferPointerCallback  )  [virtual]
 

What to do when receiving BufferPointer().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void* itk::VTKImageImport< TOutputImage, TVTKRealType >::GetCallbackUserData  )  [virtual]
 

Specify callback data.

template<typename TOutputImage, typename TVTKRealType = float>
virtual const char* itk::VTKImageImport< TOutputImage, TVTKRealType >::GetClassName  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage, typename TVTKRealType = float>
virtual DataExtentCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetDataExtentCallback  )  [virtual]
 

What to do when receiving DataExtent().

template<typename TOutputImage, typename TVTKRealType = float>
virtual NumberOfComponentsCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetNumberOfComponentsCallback  )  [virtual]
 

What to do when receiving SetNumberOfComponents().

template<typename TOutputImage, typename TVTKRealType = float>
virtual OriginCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetOriginCallback  )  [virtual]
 

What to do when receiving SetOrigin().

template<typename TOutputImage, typename TVTKRealType = float>
virtual PipelineModifiedCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetPipelineModifiedCallback  )  [virtual]
 

What to do when receiving PipelineModified().

template<typename TOutputImage, typename TVTKRealType = float>
virtual PropagateUpdateExtentCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetPropagateUpdateExtentCallback  )  [virtual]
 

What to do when receiving PropagateUpdateExtent().

template<typename TOutputImage, typename TVTKRealType = float>
virtual ScalarTypeCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetScalarTypeCallback  )  [virtual]
 

What to do when receiving UpdateInformation().

template<typename TOutputImage, typename TVTKRealType = float>
virtual SpacingCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetSpacingCallback  )  [virtual]
 

What to do when receiving SetSpacing().

template<typename TOutputImage, typename TVTKRealType = float>
virtual UpdateDataCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetUpdateDataCallback  )  [virtual]
 

What to do when receiving UpdateData().

template<typename TOutputImage, typename TVTKRealType = float>
virtual UpdateInformationCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetUpdateInformationCallback  )  [virtual]
 

What to do when receiving UpdateInformation().

template<typename TOutputImage, typename TVTKRealType = float>
virtual WholeExtentCallbackType itk::VTKImageImport< TOutputImage, TVTKRealType >::GetWholeExtentCallback  )  [virtual]
 

What to do when receiving SetWholeExtent().

template<typename TOutputImage, typename TVTKRealType = float>
itk::VTKImageImport< TOutputImage, TVTKRealType >::itkSetMacro2 CallbackUserData  ,
void * 
 

Specify callback data.

template<typename TOutputImage, typename TVTKRealType = float>
itk::VTKImageImport< TOutputImage, TVTKRealType >::itkStaticConstMacro OutputImageDimension  ,
unsigned  int,
OutputImageType::ImageDimension 
 

The output image dimension.

template<typename TOutputImage, typename TVTKRealType = float>
Pointer itk::VTKImageImport< TOutputImage, TVTKRealType >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TOutputImage, typename TVTKRealType = float>
void itk::VTKImageImport< TOutputImage, 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::ProcessObject.

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::PropagateRequestedRegion DataObject  )  [protected, virtual]
 

Send the requested region information back up the pipeline (to the filters that preceed this one).

Reimplemented from itk::ProcessObject.

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetBufferPointerCallback BufferPointerCallbackType  _arg  )  [virtual]
 

What to do when receiving BufferPointer().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetDataExtentCallback DataExtentCallbackType  _arg  )  [virtual]
 

What to do when receiving DataExtent().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetNumberOfComponentsCallback NumberOfComponentsCallbackType  _arg  )  [virtual]
 

What to do when receiving SetNumberOfComponents().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetOriginCallback OriginCallbackType  _arg  )  [virtual]
 

What to do when receiving SetOrigin().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetPipelineModifiedCallback PipelineModifiedCallbackType  _arg  )  [virtual]
 

What to do when receiving PipelineModified().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetPropagateUpdateExtentCallback PropagateUpdateExtentCallbackType  _arg  )  [virtual]
 

What to do when receiving PropagateUpdateExtent().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetScalarTypeCallback ScalarTypeCallbackType  _arg  )  [virtual]
 

What to do when receiving UpdateInformation().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetSpacingCallback SpacingCallbackType  _arg  )  [virtual]
 

What to do when receiving SetSpacing().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetUpdateDataCallback UpdateDataCallbackType  _arg  )  [virtual]
 

What to do when receiving UpdateData().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetUpdateInformationCallback UpdateInformationCallbackType  _arg  )  [virtual]
 

What to do when receiving UpdateInformation().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::SetWholeExtentCallback WholeExtentCallbackType  _arg  )  [virtual]
 

What to do when receiving SetWholeExtent().

template<typename TOutputImage, typename TVTKRealType = float>
virtual void itk::VTKImageImport< TOutputImage, TVTKRealType >::UpdateOutputInformation  )  [protected, virtual]
 

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.


The documentation for this class was generated from the following file:
Generated at Sun Jan 25 13:27:09 2004 for ITK by doxygen 1.3.3 written by Dimitri van Heesch, © 1997-2000