itk/clitkResampleImageWithOptionsFilter.txx

   1 /*=========================================================================
   2   Program:   vv                     http://www.creatis.insa-lyon.fr/rio/vv
   3
   4   Authors belong to:
   5   - University of LYON              http://www.universite-lyon.fr/
   6   - Léon Bérard cancer center       http://oncora1.lyon.fnclcc.fr
   7   - CREATIS CNRS laboratory         http://www.creatis.insa-lyon.fr
   8
   9   This software is distributed WITHOUT ANY WARRANTY; without even
  10   the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  11   PURPOSE.  See the copyright notices for more information.
  12
  13   It is distributed under dual licence
  14
  15   - BSD        See included LICENSE.txt file
  16   - CeCILL-B   http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  17   ======================================================================-====*/
  18
  19 // clitk
  20 #include "clitkDD.h"
  21
  22 // itk include
  23 #include "itkImage.h"
  24 #include "itkImageFileReader.h"
  25 #include "itkImageSeriesReader.h"
  26 #include "itkImageFileWriter.h"
  27 #include "itkRecursiveGaussianImageFilter.h"
  28 #include "itkResampleImageFilter.h"
  29 #include "itkAffineTransform.h"
  30 #include "itkNearestNeighborInterpolateImageFunction.h"
  31 #include "itkWindowedSincInterpolateImageFunction.h"
  32 #include "itkLinearInterpolateImageFunction.h"
  33 #include "itkBSplineInterpolateImageFunction.h"
  34 #include "itkBSplineInterpolateImageFunctionWithLUT.h"
  35 #include "itkCommand.h"
  36
  37 //--------------------------------------------------------------------
  38 template <class InputImageType, class OutputImageType>
  39 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
  40 ResampleImageWithOptionsFilter():itk::ImageToImageFilter<InputImageType, OutputImageType>()
  41 {
  42   static const unsigned int dim = InputImageType::ImageDimension;
  43   this->SetNumberOfRequiredInputs(1);
  44   m_OutputIsoSpacing = -1;
  45   m_InterpolationType = NearestNeighbor;
  46   m_GaussianFilteringEnabled = true;
  47   m_BSplineOrder = 3;
  48   m_BLUTSamplingFactor = 20;
  49   m_LastDimensionIsTime = false;
  50   m_Transform =  TransformType::New();
  51   if (dim == 4) m_LastDimensionIsTime = true; // by default 4D is 3D+t
  52   for(unsigned int i=0; i<dim; i++) {
  53     m_OutputSize[i] = 0;
  54     m_OutputSpacing[i] = -1;
  55     m_GaussianSigma[i] = -1;
  56   }
  57   m_VerboseOptions = false;
  58   SetDefaultPixelValue(0);
  59 }
  60 //--------------------------------------------------------------------
  61
  62
  63 //--------------------------------------------------------------------
  64 template <class InputImageType, class OutputImageType>
  65 void
  66 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
  67 SetInput(const InputImageType * image)
  68 {
  69   // Process object is not const-correct so the const casting is required.
  70   this->SetNthInput(0, const_cast<InputImageType *>(image));
  71 }
  72 //--------------------------------------------------------------------
  73
  74
  75 //--------------------------------------------------------------------
  76 template <class InputImageType, class OutputImageType>
  77 void
  78 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
  79 GenerateInputRequestedRegion()
  80 {
  81   // call the superclass's implementation of this method
  82   Superclass::GenerateInputRequestedRegion();
  83
  84   // get pointers to the input and output
  85   InputImagePointer  inputPtr  =
  86     const_cast< InputImageType *>( this->GetInput() );
  87
  88   // Request the entire input image
  89   InputImageRegionType inputRegion;
  90   inputRegion = inputPtr->GetLargestPossibleRegion();
  91   inputPtr->SetRequestedRegion(inputRegion);
  92 }
  93 //--------------------------------------------------------------------
  94
  95
  96 //--------------------------------------------------------------------
  97 template <class InputImageType, class OutputImageType>
  98 void
  99 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
 100 GenerateOutputInformation()
 101 {
 102   static const unsigned int dim = InputImageType::ImageDimension;
 103
 104   // Warning
 105   if (!std::numeric_limits<InputImagePixelType>::is_signed) {
 106     if ((m_InterpolationType == BSpline) ||
 107         (m_InterpolationType == B_LUT)) {
 108       std::cerr << "Warning : input pixel type is not signed, use bspline interpolation at your own risk ..." << std::endl;
 109     }
 110   }
 111
 112   // Get input pointer
 113   InputImagePointer input = dynamic_cast<InputImageType*>(itk::ProcessObject::GetInput(0));
 114
 115   // Perform default implementation
 116   Superclass::GenerateOutputInformation();
 117
 118   // Compute sizes
 119   InputImageSpacingType inputSpacing = input->GetSpacing();
 120   InputImageSizeType inputSize = input->GetLargestPossibleRegion().GetSize();
 121
 122   if (m_OutputIsoSpacing != -1) { // apply isoSpacing
 123     for(unsigned int i=0; i<dim; i++) {
 124       m_OutputSpacing[i] = m_OutputIsoSpacing;
 125       // I use ceil to be sure not to miss a slice
 126       m_OutputSize[i] = (int)ceil(inputSize[i]*inputSpacing[i]/m_OutputSpacing[i]);
 127     }
 128   } else {
 129     if (m_OutputSpacing[0] != -1) { // apply spacing, compute size
 130       for(unsigned int i=0; i<dim; i++) {
 131         m_OutputSize[i] = (int)ceil(inputSize[i]*inputSpacing[i]/m_OutputSpacing[i]);
 132       }
 133     } else {
 134       if (m_OutputSize[0] != 0) { // apply size, compute spacing
 135         for(unsigned int i=0; i<dim; i++) {
 136           m_OutputSpacing[i] = (double)inputSize[i]*inputSpacing[i]/(double)m_OutputSize[i];
 137         }
 138       } else { // copy input size/spacing ... (no resampling)
 139         m_OutputSize = inputSize;
 140         m_OutputSpacing = inputSpacing;
 141       }
 142     }
 143   }
 144
 145   // Special case for temporal image 2D+t or 3D+t
 146   if (m_LastDimensionIsTime) {
 147     int l = dim-1;
 148     m_OutputSize[l] = inputSize[l];
 149     m_OutputSpacing[l] = inputSpacing[l];
 150   }
 151
 152   // Set Size/Spacing
 153   OutputImagePointer outputImage = this->GetOutput(0);
 154   // OutputImageRegionType region;
 155   m_OutputRegion.SetSize(m_OutputSize);
 156   m_OutputRegion.SetIndex(input->GetLargestPossibleRegion().GetIndex());
 157   outputImage->CopyInformation(input);
 158   outputImage->SetLargestPossibleRegion(m_OutputRegion);
 159   outputImage->SetSpacing(m_OutputSpacing);
 160   outputImage->FillBuffer(GetDefaultPixelValue());
 161
 162   // Init Gaussian sigma
 163   if (m_GaussianSigma[0] != -1) { // Gaussian filter set by user
 164     m_GaussianFilteringEnabled = true;
 165   }
 166   else {
 167     if (m_GaussianFilteringEnabled) { // Automated sigma when downsample
 168       for(unsigned int i=0; i<dim; i++) {
 169         if (m_OutputSpacing[i] > inputSpacing[i]) { // downsample
 170           m_GaussianSigma[i] = 0.5*m_OutputSpacing[i];// / inputSpacing[i]);
 171         }
 172         else m_GaussianSigma[i] = 0; // will be ignore after
 173       }
 174     }
 175   }
 176   if (m_GaussianFilteringEnabled && m_LastDimensionIsTime) {
 177     m_GaussianSigma[dim-1] = 0;
 178   }
 179 }
 180 //--------------------------------------------------------------------
 181
 182
 183 //--------------------------------------------------------------------
 184 template <class InputImageType, class OutputImageType>
 185 void
 186 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
 187 GenerateData()
 188 {
 189
 190   // Get input pointer
 191   InputImagePointer input = dynamic_cast<InputImageType*>(itk::ProcessObject::GetInput(0));
 192   static const unsigned int dim = InputImageType::ImageDimension;
 193
 194   // Create main Resample Image Filter
 195   typedef itk::ResampleImageFilter<InputImageType,OutputImageType> FilterType;
 196   typename FilterType::Pointer filter = FilterType::New();
 197   filter->GraftOutput(this->GetOutput());
 198   this->GetOutput()->SetBufferedRegion(this->GetOutput()->GetLargestPossibleRegion());
 199
 200   // Print options if needed
 201   if (m_VerboseOptions) {
 202     std::cout << "Output Spacing = " << m_OutputSpacing << std::endl
 203               << "Output Size    = " << m_OutputSize << std::endl
 204               << "Gaussian       = " << m_GaussianFilteringEnabled << std::endl;
 205     if (m_GaussianFilteringEnabled)
 206       std::cout << "Sigma          = " << m_GaussianSigma << std::endl;
 207     std::cout << "Interpol       = ";
 208     switch (m_InterpolationType) {
 209     case NearestNeighbor: std::cout << "NearestNeighbor" << std::endl; break;
 210     case Linear: std::cout << "Linear" << std::endl; break;
 211     case BSpline: std::cout << "BSpline " << m_BSplineOrder << std::endl; break;
 212     case B_LUT: std::cout << "B-LUT " << m_BSplineOrder << " " << m_BLUTSamplingFactor << std::endl; break;
 213     case WSINC: std::cout << "Windowed Sinc" << std::endl; break;
 214     }
 215     std::cout << "Threads        = " << this->GetNumberOfThreads() << std::endl;
 216     std::cout << "LastDimIsTime  = " << m_LastDimensionIsTime << std::endl;
 217   }
 218
 219   // Instance of the transform object to be passed to the resample
 220   // filter. By default, identity transform is applied
 221   filter->SetTransform(m_Transform);
 222   filter->SetSize(m_OutputSize);
 223   filter->SetOutputSpacing(m_OutputSpacing);
 224   filter->SetOutputOrigin(input->GetOrigin());
 225   filter->SetDefaultPixelValue(m_DefaultPixelValue);
 226   filter->SetNumberOfThreads(this->GetNumberOfThreads());
 227   filter->SetOutputDirection(input->GetDirection()); // <-- NEEDED if we want to keep orientation (in case of PermutAxes for example)
 228
 229   // Select interpolator
 230   switch (m_InterpolationType) {
 231   case NearestNeighbor: {
 232     typedef itk::NearestNeighborInterpolateImageFunction<InputImageType, double> InterpolatorType;
 233     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 234     filter->SetInterpolator(interpolator);
 235     break;
 236   }
 237   case Linear: {
 238     typedef itk::LinearInterpolateImageFunction<InputImageType, double> InterpolatorType;
 239     typename InterpolatorType::Pointer interpolator =  InterpolatorType::New();
 240     filter->SetInterpolator(interpolator);
 241     break;
 242   }
 243   case BSpline: {
 244     typedef itk::BSplineInterpolateImageFunction<InputImageType, double> InterpolatorType;
 245     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 246     interpolator->SetSplineOrder(m_BSplineOrder);
 247     filter->SetInterpolator(interpolator);
 248     break;
 249   }
 250   case B_LUT: {
 251     typedef itk::BSplineInterpolateImageFunctionWithLUT<InputImageType, double> InterpolatorType;
 252     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 253     interpolator->SetSplineOrder(m_BSplineOrder);
 254     interpolator->SetLUTSamplingFactor(m_BLUTSamplingFactor);
 255     filter->SetInterpolator(interpolator);
 256     break;
 257   }
 258   case WSINC: {
 259     typedef itk::WindowedSincInterpolateImageFunction<InputImageType, 4> InterpolatorType;
 260     typename InterpolatorType::Pointer interpolator =  InterpolatorType::New();
 261     filter->SetInterpolator(interpolator);
 262     break;
 263   }
 264   }
 265
 266   // Initial Gaussian blurring if needed
 267   // TODO : replace by itk::DiscreteGaussianImageFilter for small sigma
 268   typedef itk::RecursiveGaussianImageFilter<InputImageType, InputImageType> GaussianFilterType;
 269   std::vector<typename GaussianFilterType::Pointer> gaussianFilters;
 270   if (m_GaussianFilteringEnabled) {
 271     for(unsigned int i=0; i<dim; i++) {
 272       if (m_GaussianSigma[i] != 0) {
 273         gaussianFilters.push_back(GaussianFilterType::New());
 274         gaussianFilters[i]->SetDirection(i);
 275         gaussianFilters[i]->SetOrder(GaussianFilterType::ZeroOrder);
 276         gaussianFilters[i]->SetNormalizeAcrossScale(false);
 277         gaussianFilters[i]->SetSigma(m_GaussianSigma[i]); // in millimeter !
 278         if (gaussianFilters.size() == 1) { // first
 279           gaussianFilters[0]->SetInput(input);
 280         } else {
 281           gaussianFilters[i]->SetInput(gaussianFilters[i-1]->GetOutput());
 282         }
 283       }
 284     }
 285     if (gaussianFilters.size() > 0) {
 286       filter->SetInput(gaussianFilters[gaussianFilters.size()-1]->GetOutput());
 287     } else filter->SetInput(input);
 288   } else filter->SetInput(input);
 289
 290   // Go !
 291   filter->Update();
 292
 293   // Set output
 294   // DD("before Graft");
 295
 296   //this->GraftOutput(filter->GetOutput());
 297   this->SetNthOutput(0, filter->GetOutput());
 298
 299   // DD("after Graft");
 300 }
 301 //--------------------------------------------------------------------
 302
 303
 304 //--------------------------------------------------------------------
 305 template<class InputImageType>
 306 typename InputImageType::Pointer
 307 clitk::ResampleImageSpacing(typename InputImageType::Pointer input,
 308                             typename InputImageType::SpacingType spacing,
 309                             int interpolationType)
 310 {
 311   typedef clitk::ResampleImageWithOptionsFilter<InputImageType> ResampleFilterType;
 312   typename ResampleFilterType::Pointer resampler = ResampleFilterType::New();
 313   resampler->SetInput(input);
 314   resampler->SetOutputSpacing(spacing);
 315   typename ResampleFilterType::InterpolationTypeEnumeration inter=ResampleFilterType::NearestNeighbor;
 316   switch(interpolationType) {
 317   case 0: inter = ResampleFilterType::NearestNeighbor; break;
 318   case 1: inter = ResampleFilterType::Linear; break;
 319   case 2: inter = ResampleFilterType::BSpline; break;
 320   case 3: inter = ResampleFilterType::B_LUT; break;
 321   case 4: inter = ResampleFilterType::WSINC; break;
 322   }
 323   resampler->SetInterpolationType(inter);
 324   resampler->SetGaussianFilteringEnabled(true);
 325   resampler->Update();
 326   return resampler->GetOutput();
 327 }
 328 //--------------------------------------------------------------------