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://www.centreleonberard.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       // floor() is used to intentionally reduce the number of slices
 126       // because, from a clinical point of view, it's better to
 127       // remove data than to add data that privously didn't exist.
 128       if(inputSpacing[i]*m_OutputSpacing[i]<0)
 129         itkExceptionMacro( << "Input and output spacings don't have the same signs, can't cope with that" );
 130       m_OutputSize[i] = (int)floor(inputSize[i]*inputSpacing[i]/m_OutputSpacing[i]);
 131     }
 132   } else {
 133     if (m_OutputSpacing[0] != -1) { // apply spacing, compute size
 134       for(unsigned int i=0; i<dim; i++) {
 135         if(inputSpacing[i]*m_OutputSpacing[i]<0)
 136           itkExceptionMacro( << "Input and output spacings don't have the same signs, can't cope with that" );
 137         // see comment above for the use of floor()
 138         m_OutputSize[i] = (int)floor(inputSize[i]*inputSpacing[i]/m_OutputSpacing[i]);
 139       }
 140     } else {
 141       if (m_OutputSize[0] != 0) { // apply size, compute spacing
 142         for(unsigned int i=0; i<dim; i++) {
 143           m_OutputSpacing[i] = (double)inputSize[i]*inputSpacing[i]/(double)m_OutputSize[i];
 144         }
 145       } else { // copy input size/spacing ... (no resampling)
 146         m_OutputSize = inputSize;
 147         m_OutputSpacing = inputSpacing;
 148       }
 149     }
 150   }
 151
 152   // Special case for temporal image 2D+t or 3D+t
 153   if (m_LastDimensionIsTime) {
 154     int l = dim-1;
 155     m_OutputSize[l] = inputSize[l];
 156     m_OutputSpacing[l] = inputSpacing[l];
 157   }
 158
 159   // Set Size/Spacing
 160   OutputImagePointer outputImage = this->GetOutput(0);
 161   // OutputImageRegionType region;
 162   m_OutputRegion.SetSize(m_OutputSize);
 163   m_OutputRegion.SetIndex(input->GetLargestPossibleRegion().GetIndex());
 164   outputImage->CopyInformation(input);
 165   outputImage->SetLargestPossibleRegion(m_OutputRegion);
 166   outputImage->SetSpacing(m_OutputSpacing);
 167
 168   // Init Gaussian sigma
 169   if (m_GaussianSigma[0] != -1) { // Gaussian filter set by user
 170     m_GaussianFilteringEnabled = true;
 171   }
 172   else {
 173     if (m_GaussianFilteringEnabled) { // Automated sigma when downsample
 174       for(unsigned int i=0; i<dim; i++) {
 175         if (m_OutputSpacing[i] > inputSpacing[i]) { // downsample
 176           m_GaussianSigma[i] = 0.5*m_OutputSpacing[i];// / inputSpacing[i]);
 177         }
 178         else m_GaussianSigma[i] = 0; // will be ignore after
 179       }
 180     }
 181   }
 182   if (m_GaussianFilteringEnabled && m_LastDimensionIsTime) {
 183     m_GaussianSigma[dim-1] = 0;
 184   }
 185 }
 186 //--------------------------------------------------------------------
 187
 188
 189 //--------------------------------------------------------------------
 190 template <class InputImageType, class OutputImageType>
 191 void
 192 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
 193 GenerateData()
 194 {
 195
 196   // Get input pointer
 197   InputImagePointer input = dynamic_cast<InputImageType*>(itk::ProcessObject::GetInput(0));
 198   static const unsigned int dim = InputImageType::ImageDimension;
 199
 200   // Create main Resample Image Filter
 201   typedef itk::ResampleImageFilter<InputImageType,OutputImageType> FilterType;
 202   typename FilterType::Pointer filter = FilterType::New();
 203   filter->GraftOutput(this->GetOutput());
 204   this->GetOutput()->SetBufferedRegion(this->GetOutput()->GetLargestPossibleRegion());
 205
 206   // Print options if needed
 207   if (m_VerboseOptions) {
 208     std::cout << "Output Spacing = " << m_OutputSpacing << std::endl
 209               << "Output Size    = " << m_OutputSize << std::endl
 210               << "Gaussian       = " << m_GaussianFilteringEnabled << std::endl;
 211     if (m_GaussianFilteringEnabled)
 212       std::cout << "Sigma          = " << m_GaussianSigma << std::endl;
 213     std::cout << "Interpol       = ";
 214     switch (m_InterpolationType) {
 215     case NearestNeighbor: std::cout << "NearestNeighbor" << std::endl; break;
 216     case Linear: std::cout << "Linear" << std::endl; break;
 217     case BSpline: std::cout << "BSpline " << m_BSplineOrder << std::endl; break;
 218     case B_LUT: std::cout << "B-LUT " << m_BSplineOrder << " " << m_BLUTSamplingFactor << std::endl; break;
 219     case WSINC: std::cout << "Windowed Sinc" << std::endl; break;
 220     }
 221     std::cout << "Threads        = " << this->GetNumberOfThreads() << std::endl;
 222     std::cout << "LastDimIsTime  = " << m_LastDimensionIsTime << std::endl;
 223   }
 224
 225   // Instance of the transform object to be passed to the resample
 226   // filter. By default, identity transform is applied
 227   filter->SetTransform(m_Transform);
 228   filter->SetSize(m_OutputSize);
 229   filter->SetOutputSpacing(m_OutputSpacing);
 230   filter->SetOutputOrigin(input->GetOrigin());
 231   filter->SetDefaultPixelValue(m_DefaultPixelValue);
 232   filter->SetNumberOfThreads(this->GetNumberOfThreads());
 233   filter->SetOutputDirection(input->GetDirection()); // <-- NEEDED if we want to keep orientation (in case of PermutAxes for example)
 234
 235   // Select interpolator
 236   switch (m_InterpolationType) {
 237   case NearestNeighbor: {
 238     typedef itk::NearestNeighborInterpolateImageFunction<InputImageType, double> InterpolatorType;
 239     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 240     filter->SetInterpolator(interpolator);
 241     break;
 242   }
 243   case Linear: {
 244     typedef itk::LinearInterpolateImageFunction<InputImageType, double> InterpolatorType;
 245     typename InterpolatorType::Pointer interpolator =  InterpolatorType::New();
 246     filter->SetInterpolator(interpolator);
 247     break;
 248   }
 249   case BSpline: {
 250     typedef itk::BSplineInterpolateImageFunction<InputImageType, double> InterpolatorType;
 251     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 252     interpolator->SetSplineOrder(m_BSplineOrder);
 253     filter->SetInterpolator(interpolator);
 254     break;
 255   }
 256   case B_LUT: {
 257     typedef itk::BSplineInterpolateImageFunctionWithLUT<InputImageType, double> InterpolatorType;
 258     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 259     interpolator->SetSplineOrder(m_BSplineOrder);
 260     interpolator->SetLUTSamplingFactor(m_BLUTSamplingFactor);
 261     filter->SetInterpolator(interpolator);
 262     break;
 263   }
 264   case WSINC: {
 265     typedef itk::WindowedSincInterpolateImageFunction<InputImageType, 4> InterpolatorType;
 266     typename InterpolatorType::Pointer interpolator =  InterpolatorType::New();
 267     filter->SetInterpolator(interpolator);
 268     break;
 269   }
 270   }
 271
 272   // Initial Gaussian blurring if needed
 273   // TODO : replace by itk::DiscreteGaussianImageFilter for small sigma
 274   typedef itk::RecursiveGaussianImageFilter<InputImageType, InputImageType> GaussianFilterType;
 275   std::vector<typename GaussianFilterType::Pointer> gaussianFilters;
 276   if (m_GaussianFilteringEnabled) {
 277     for(unsigned int i=0; i<dim; i++) {
 278       if (m_GaussianSigma[i] != 0) {
 279         gaussianFilters.push_back(GaussianFilterType::New());
 280         gaussianFilters[i]->SetDirection(i);
 281         gaussianFilters[i]->SetOrder(GaussianFilterType::ZeroOrder);
 282         gaussianFilters[i]->SetNormalizeAcrossScale(false);
 283         gaussianFilters[i]->SetSigma(m_GaussianSigma[i]); // in millimeter !
 284         if (gaussianFilters.size() == 1) { // first
 285           gaussianFilters[0]->SetInput(input);
 286         } else {
 287           gaussianFilters[i]->SetInput(gaussianFilters[i-1]->GetOutput());
 288         }
 289       }
 290     }
 291     if (gaussianFilters.size() > 0) {
 292       filter->SetInput(gaussianFilters[gaussianFilters.size()-1]->GetOutput());
 293     } else filter->SetInput(input);
 294   } else filter->SetInput(input);
 295
 296   // Go !
 297   filter->Update();
 298
 299   // Set output
 300   // DD("before Graft");
 301
 302   //this->GraftOutput(filter->GetOutput());
 303   this->SetNthOutput(0, filter->GetOutput());
 304
 305   // DD("after Graft");
 306 }
 307 //--------------------------------------------------------------------
 308
 309
 310 //--------------------------------------------------------------------
 311 template<class InputImageType>
 312 typename InputImageType::Pointer
 313 clitk::ResampleImageSpacing(typename InputImageType::Pointer input,
 314                             typename InputImageType::SpacingType spacing,
 315                             int interpolationType)
 316 {
 317   typedef clitk::ResampleImageWithOptionsFilter<InputImageType> ResampleFilterType;
 318   typename ResampleFilterType::Pointer resampler = ResampleFilterType::New();
 319   resampler->SetInput(input);
 320   resampler->SetOutputSpacing(spacing);
 321   typename ResampleFilterType::InterpolationTypeEnumeration inter=ResampleFilterType::NearestNeighbor;
 322   switch(interpolationType) {
 323   case 0: inter = ResampleFilterType::NearestNeighbor; break;
 324   case 1: inter = ResampleFilterType::Linear; break;
 325   case 2: inter = ResampleFilterType::BSpline; break;
 326   case 3: inter = ResampleFilterType::B_LUT; break;
 327   case 4: inter = ResampleFilterType::WSINC; break;
 328   }
 329   resampler->SetInterpolationType(inter);
 330   resampler->SetGaussianFilteringEnabled(true);
 331   resampler->Update();
 332   return resampler->GetOutput();
 333 }
 334 //--------------------------------------------------------------------