common/clitkImageToImageGenericFilterBase.h

   1 /*=========================================================================
   2
   3   Program:   clitk
   4   Module:    $RCSfile: clitkImageToImageGenericFilterBase.h,v $
   5   Language:  C++
   6   Date:      $Date: 2010/03/02 13:02:52 $
   7   Version:   $Revision: 1.1 $
   8   Author :   Joel Schaerer <joel.schaerer@creatis.insa-lyon.fr>
   9              David Sarrut <david.sarrut@creatis.insa-lyon.fr>
  10
  11   Copyright (C) 2008
  12   Léon Bérard cancer center http://oncora1.lyon.fnclcc.fr
  13   CREATIS-LRMN http://www.creatis.insa-lyon.fr
  14
  15   This program is free software: you can redistribute it and/or modify
  16   it under the terms of the GNU General Public License as published by
  17   the Free Software Foundation, version 3 of the License.
  18
  19   This program is distributed in the hope that it will be useful,
  20   but WITHOUT ANY WARRANTY; without even the implied warranty of
  21   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22   GNU General Public License for more details.
  23
  24   You should have received a copy of the GNU General Public License
  25   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26
  27   =========================================================================*/
  28
  29 #ifndef CLITKIMAGETOIMAGEGENERICFILTERBASE_H
  30 #define CLITKIMAGETOIMAGEGENERICFILTERBASE_H
  31
  32 // clitk include
  33 #include "clitkCommon.h"
  34 #include "clitkImageCommon.h"
  35 #include "clitkCommonGenericFilter.h"
  36
  37 // itk include
  38 #include <itkImage.h>
  39
  40 // vv include
  41 #include "vvImage.h"
  42 #include "vvFromITK.h"
  43 #include "vvToITK.h"
  44
  45 namespace clitk {
  46
  47   //--------------------------------------------------------------------
  48   class ImageToImageGenericFilterBase: public itk::Object {
  49
  50   public:
  51     // constructor - destructor
  52     ImageToImageGenericFilterBase(std::string filterName);
  53     virtual ~ImageToImageGenericFilterBase();
  54
  55     // Types
  56     typedef ImageToImageGenericFilterBase Self;
  57     typedef Object                        Superclass;
  58     typedef itk::SmartPointer<Self>       Pointer;
  59     typedef itk::SmartPointer<const Self> ConstPointer;
  60
  61     // Filters information
  62     const std::string & GetFilterName();
  63     void SetFilterName(std::string & n);
  64
  65     // Generic IO
  66     /// Returns the dimension and pixel type of the *first* input
  67     void GetInputImageDimensionAndPixelType(unsigned int& dim, std::string& pixeltype,
  68                                             unsigned int & components);
  69
  70     // File IO
  71     void SetInputFilename(const std::string & filename);
  72     void AddInputFilename(const std::string & filename);
  73     void SetInputFilenames(const std::vector<std::string> & filenames);
  74     void SetOutputFilename(const std::string & filename);
  75     void AddOutputFilename(const std::string & filename);
  76     void SetOutputFilenames(const std::vector<std::string> & filenames);
  77     std::string GetOutputFilename();
  78     void SetIOVerbose(bool b);
  79
  80     // VVImage IO
  81     void SetInputVVImage (vvImage::Pointer input);
  82     void SetInputVVImages (std::vector<vvImage::Pointer> input);
  83     void AddInputVVImage (vvImage::Pointer input);
  84     vvImage::Pointer GetOutputVVImage ();
  85     std::vector<vvImage::Pointer> GetOutputVVImages ();
  86
  87     // Information on available image types
  88     void PrintAvailableImageTypes();
  89     virtual std::string GetAvailableImageTypes() = 0;
  90
  91     virtual bool CheckImageType(unsigned int dim,unsigned int ncomp, std::string pixeltype) = 0;
  92     virtual bool CheckImageType() = 0;
  93
  94     // Main function to call for using the filter.
  95     virtual bool Update() = 0;
  96
  97   protected:
  98     /// Call this function to dispatch an output towards the correct sink
  99     template<class ImageType>
 100     void SetNextOutput(typename ImageType::Pointer output);
 101
 102     /// Call this function to get the nth itk input image, regardless of input source
 103     template<class ImageType>
 104     typename ImageType::Pointer GetInput(unsigned int n);
 105
 106     std::vector<std::string> mInputFilenames;
 107     std::list<std::string> mOutputFilenames;
 108
 109     bool mIOVerbose;
 110     unsigned int mDim;
 111     std::string mPixelTypeName;
 112     unsigned int mNbOfComponents;
 113     std::string mFilterName;
 114
 115     std::vector<vvImage::Pointer> mInputVVImages;
 116     std::vector<vvImage::Pointer> mOutputVVImages;
 117
 118     void ImageTypeError();
 119     void SetImageTypeError();
 120     bool mFailOnImageTypeError;
 121
 122   }; // end class clitk::ImageToImageGenericFilter
 123
 124 #define ADD_VEC_IMAGE_TYPE(DIM, COMP, PT) this->mImageTypesManager.template AddNewDimensionAndPixelType<DIM,COMP, PT>();
 125 #define ADD_IMAGE_TYPE(DIM, PT) this->mImageTypesManager.template AddNewDimensionAndPixelType<DIM, PT>();
 126
 127 #include "clitkImageToImageGenericFilterBase.txx"
 128
 129 } // end namespace
 130
 131 #endif /* end #define CLITKIMAGETOIMAGEGENERICFILTERBASE_H */
 132