]> Creatis software - bbtk.git/blob - packages/itkvtk/src/itkVTKImageToImageFilter.h
Feature #1774
[bbtk.git] / packages / itkvtk / src / itkVTKImageToImageFilter.h
1 /*
2 # ---------------------------------------------------------------------
3 #
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 #                        pour la SantÈ)
6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9 #
10 #  This software is governed by the CeCILL-B license under French law and
11 #  abiding by the rules of distribution of free software. You can  use,
12 #  modify and/ or redistribute the software under the terms of the CeCILL-B
13 #  license as circulated by CEA, CNRS and INRIA at the following URL
14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15 #  or in the file LICENSE.txt.
16 #
17 #  As a counterpart to the access to the source code and  rights to copy,
18 #  modify and redistribute granted by the license, users are provided only
19 #  with a limited warranty  and the software's author,  the holder of the
20 #  economic rights,  and the successive licensors  have only  limited
21 #  liability.
22 #
23 #  The fact that you are presently reading this means that you have had
24 #  knowledge of the CeCILL-B license and that you accept its terms.
25 # ------------------------------------------------------------------------ */
26
27
28 /*=========================================================================
29
30   Program:   Insight Segmentation & Registration Toolkit
31   Module:    $RCSfile: itkVTKImageToImageFilter.h,v $
32   Language:  C++
33   Date:      $Date: 2012/11/16 08:50:49 $
34   Version:   $Revision: 1.3 $
35
36
37 =========================================================================*/
38 #ifndef __itkVTKImageToImageFilter_h
39 #define __itkVTKImageToImageFilter_h
40
41 #include "itkVTKImageImport.h"
42 #include "vtkImageExport.h"
43 #include "vtkImageData.h"
44
45 #ifndef vtkFloatingPointType
46 #define vtkFloatingPointType float
47 #endif
48
49 namespace itk
50 {
51
52 /** \class VTKImageToImageFilter
53  * \brief Converts a VTK image into an ITK image and plugs a 
54  *  vtk data pipeline to an ITK datapipeline.   
55  *
56  *  This class puts together an itkVTKImageImporter and a vtkImageExporter.
57  *  It takes care of the details related to the connection of ITK and VTK
58  *  pipelines. The User will perceive this filter as an adaptor to which
59  *  a vtkImage can be plugged as input and an itk::Image is produced as 
60  *  output.
61  * 
62  * \ingroup   ImageFilters     
63  */
64 template <class TOutputImage >
65 class ITK_EXPORT VTKImageToImageFilter : public ProcessObject
66 {
67 public:
68   /** Standard class typedefs. */
69   typedef VTKImageToImageFilter     Self;
70   typedef ProcessObject             Superclass;
71   typedef SmartPointer<Self>        Pointer;
72   typedef SmartPointer<const Self>  ConstPointer;
73
74   /** Method for creation through the object factory. */
75   itkNewMacro(Self);
76   
77   /** Run-time type information (and related methods). */
78   itkTypeMacro(VTKImageToImageFilter, ProcessObject);
79
80   /** Some typedefs. */
81   typedef TOutputImage OutputImageType;
82   typedef typename OutputImageType::ConstPointer    OutputImagePointer;
83   typedef VTKImageImport< OutputImageType >         ImporterFilterType; 
84   typedef typename ImporterFilterType::Pointer      ImporterFilterPointer;
85  
86   /** Get the output in the form of a vtkImage. 
87       This call is delegated to the internal vtkImageImporter filter  */
88   const OutputImageType *  GetOutput() const;
89
90   /** Set the input in the form of a vtkImageData */
91   void SetInput( vtkImageData * );
92
93   /** Return the internal VTK image exporter filter.
94       This is intended to facilitate users the access 
95       to methods in the exporter */
96   vtkImageExport * GetExporter() const;
97
98   /** Return the internal ITK image importer filter.
99       This is intended to facilitate users the access 
100       to methods in the importer */
101   ImporterFilterType * GetImporter() const;
102   
103   /** This call delegate the update to the importer */
104   void Update();
105   
106 protected:
107   VTKImageToImageFilter(); 
108   virtual ~VTKImageToImageFilter(); 
109
110 private:
111   VTKImageToImageFilter(const Self&); //purposely not implemented
112   void operator=(const Self&); //purposely not implemented
113
114   ImporterFilterPointer       m_Importer;
115   vtkImageExport            * m_Exporter;
116
117 };
118
119 } // end namespace itk
120
121 #ifndef ITK_MANUAL_INSTANTIATION
122 #include "itkVTKImageToImageFilter.txx"
123 #endif
124
125 #endif
126
127
128