]> Creatis software - bbtk.git/blob - packages/itkvtk/src/itkImageToVTKImageFilter.h
Feature #1774
[bbtk.git] / packages / itkvtk / src / itkImageToVTKImageFilter.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: itkImageToVTKImageFilter.h,v $
32   Language:  C++
33   Date:      $Date: 2012/11/16 08:50:49 $
34   Version:   $Revision: 1.2 $
35
36
37 =========================================================================*/
38 #ifndef __itkImageToVTKImageFilter_h
39 #define __itkImageToVTKImageFilter_h
40
41 #include "itkVTKImageExport.h"
42 #include "vtkImageImport.h"
43 #include "vtkImageData.h"
44
45 namespace itk
46 {
47   
48 /** \class ImageToVTKImageFilter
49  * \brief Converts an ITK image into a VTK image and plugs a 
50  *  itk data pipeline to a VTK datapipeline.   
51  *
52  *  This class puts together an itkVTKImageExporter and a vtkImageImporter.
53  *  It takes care of the details related to the connection of ITK and VTK
54  *  pipelines. The User will perceive this filter as an adaptor to which
55  *  an itk::Image can be plugged as input and a vtkImage is produced as 
56  *  output.
57  * 
58  * \ingroup   ImageFilters     
59  */
60 template <class TInputImage >
61 class ITK_EXPORT ImageToVTKImageFilter : public ProcessObject
62 {
63 public:
64   /** Standard class typedefs. */
65   typedef ImageToVTKImageFilter       Self;
66   typedef ProcessObject             Superclass;
67   typedef SmartPointer<Self>        Pointer;
68   typedef SmartPointer<const Self>  ConstPointer;
69
70   /** Method for creation through the object factory. */
71   itkNewMacro(Self);
72   
73   /** Run-time type information (and related methods). */
74   itkTypeMacro(ImageToVTKImageFilter, ProcessObject);
75
76   /** Some typedefs. */
77   typedef TInputImage InputImageType;
78   typedef typename    InputImageType::ConstPointer    InputImagePointer;
79   typedef VTKImageExport< InputImageType>            ExporterFilterType; 
80   typedef typename ExporterFilterType::Pointer        ExporterFilterPointer;
81  
82   /** Get the output in the form of a vtkImage. 
83       This call is delegated to the internal vtkImageImporter filter  */
84   vtkImageData *  GetOutput() const;
85
86   /** Set the input in the form of an itk::Image */
87   void SetInput( const InputImageType * );
88
89   /** Return the internal VTK image importer filter.
90       This is intended to facilitate users the access 
91       to methods in the importer */
92   vtkImageImport * GetImporter() const;
93
94   /** Return the internal ITK image exporter filter.
95       This is intended to facilitate users the access 
96       to methods in the exporter */
97   ExporterFilterType * GetExporter() const;
98   
99   /** This call delegate the update to the importer */
100   void Update();
101   
102 protected:
103   ImageToVTKImageFilter(); 
104   virtual ~ImageToVTKImageFilter(); 
105
106 private:
107   ImageToVTKImageFilter(const Self&); //purposely not implemented
108   void operator=(const Self&); //purposely not implemented
109
110   ExporterFilterPointer       m_Exporter;
111   vtkImageImport            * m_Importer;
112
113 };
114
115 } // end namespace itk
116
117 #ifndef ITK_MANUAL_INSTANTIATION
118 #include "itkImageToVTKImageFilter.txx"
119 #endif
120
121 #endif
122
123
124