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_OutputOrigin.Fill(0);
  58   m_OutputDirection.SetIdentity();
  59   m_VerboseOptions = false;
  60   SetDefaultPixelValue(0);
  61 }
  62 //--------------------------------------------------------------------
  63
  64
  65 //--------------------------------------------------------------------
  66 template <class InputImageType, class OutputImageType>
  67 void
  68 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
  69 SetInput(const InputImageType * image)
  70 {
  71   // Process object is not const-correct so the const casting is required.
  72   this->SetNthInput(0, const_cast<InputImageType *>(image));
  73 }
  74 //--------------------------------------------------------------------
  75
  76
  77 //--------------------------------------------------------------------
  78 template <class InputImageType, class OutputImageType>
  79 void
  80 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
  81 GenerateInputRequestedRegion()
  82 {
  83   // call the superclass's implementation of this method
  84   Superclass::GenerateInputRequestedRegion();
  85
  86   // get pointers to the input and output
  87   InputImagePointer  inputPtr  =
  88     const_cast< InputImageType *>( this->GetInput() );
  89
  90   // Request the entire input image
  91   InputImageRegionType inputRegion;
  92   inputRegion = inputPtr->GetLargestPossibleRegion();
  93   inputPtr->SetRequestedRegion(inputRegion);
  94 }
  95 //--------------------------------------------------------------------
  96
  97
  98 //--------------------------------------------------------------------
  99 template <class InputImageType, class OutputImageType>
 100 void
 101 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
 102 GenerateOutputInformation()
 103 {
 104   static const unsigned int dim = InputImageType::ImageDimension;
 105
 106   // Warning
 107   if (!std::numeric_limits<InputImagePixelType>::is_signed) {
 108     if ((m_InterpolationType == BSpline) ||
 109         (m_InterpolationType == B_LUT)) {
 110       std::cerr << "Warning : input pixel type is not signed, use bspline interpolation at your own risk ..." << std::endl;
 111     }
 112   }
 113
 114   // Get input pointer
 115   InputImagePointer input = dynamic_cast<InputImageType*>(itk::ProcessObject::GetInput(0));
 116
 117   // Perform default implementation
 118   Superclass::GenerateOutputInformation();
 119
 120   // Compute sizes
 121   InputImageSpacingType inputSpacing = input->GetSpacing();
 122   InputImageSizeType inputSize = input->GetLargestPossibleRegion().GetSize();
 123
 124   if (m_OutputIsoSpacing != -1) { // apply isoSpacing
 125     for(unsigned int i=0; i<dim; i++) {
 126       m_OutputSpacing[i] = m_OutputIsoSpacing;
 127       // floor() is used to intentionally reduce the number of slices
 128       // because, from a clinical point of view, it's better to
 129       // remove data than to add data that privously didn't exist.
 130       if(inputSpacing[i]*m_OutputSpacing[i]<0)
 131         itkExceptionMacro( << "Input and output spacings don't have the same signs, can't cope with that" );
 132       m_OutputSize[i] = (int)floor(inputSize[i]*inputSpacing[i]/m_OutputSpacing[i]);
 133     }
 134   }
 135   else if(m_OutputSpacing[0]==-1 ||  m_OutputSize[0]==0){
 136     if (m_OutputSpacing[0] != -1) { // apply spacing, compute size
 137       for(unsigned int i=0; i<dim; i++) {
 138         if(inputSpacing[i]*m_OutputSpacing[i]<0) {
 139           itkExceptionMacro( << "Input and output spacings don't have the same signs, can't cope with that" );
 140         }
 141         // see comment above for the use of floor()
 142         m_OutputSize[i] = (int)floor(inputSize[i]*inputSpacing[i]/m_OutputSpacing[i]);
 143       }
 144     }
 145     else {
 146       if (m_OutputSize[0] != 0) { // apply size, compute spacing
 147         for(unsigned int i=0; i<dim; i++) {
 148           m_OutputSpacing[i] = (double)inputSize[i]*inputSpacing[i]/(double)m_OutputSize[i];
 149         }
 150       }
 151       else { // copy input size/spacing ... (no resampling)
 152         m_OutputSize = inputSize;
 153         m_OutputSpacing = inputSpacing;
 154       }
 155     }
 156   }
 157
 158   // Special case for temporal image 2D+t or 3D+t
 159   if (m_LastDimensionIsTime) {
 160     int l = dim-1;
 161     m_OutputSize[l] = inputSize[l];
 162     m_OutputSpacing[l] = inputSpacing[l];
 163   }
 164
 165   // Set Size/Spacing
 166   OutputImagePointer outputImage = this->GetOutput(0);
 167   // OutputImageRegionType region;
 168   m_OutputRegion.SetSize(m_OutputSize);
 169   m_OutputRegion.SetIndex(input->GetLargestPossibleRegion().GetIndex());
 170   outputImage->CopyInformation(input);
 171   outputImage->SetLargestPossibleRegion(m_OutputRegion);
 172   outputImage->SetSpacing(m_OutputSpacing);
 173
 174   // Init Gaussian sigma
 175   if (m_GaussianSigma[0] != -1) { // Gaussian filter set by user
 176     m_GaussianFilteringEnabled = true;
 177   }
 178   else {
 179     if (m_GaussianFilteringEnabled) { // Automated sigma when downsample
 180       for(unsigned int i=0; i<dim; i++) {
 181         if (m_OutputSpacing[i] > inputSpacing[i]) { // downsample
 182           m_GaussianSigma[i] = 0.5*m_OutputSpacing[i];// / inputSpacing[i]);
 183         }
 184         else m_GaussianSigma[i] = 0; // will be ignore after
 185       }
 186     }
 187   }
 188   if (m_GaussianFilteringEnabled && m_LastDimensionIsTime) {
 189     m_GaussianSigma[dim-1] = 0;
 190   }
 191 }
 192 //--------------------------------------------------------------------
 193
 194
 195 //--------------------------------------------------------------------
 196 template <class InputImageType, class OutputImageType>
 197 void
 198 clitk::ResampleImageWithOptionsFilter<InputImageType, OutputImageType>::
 199 GenerateData()
 200 {
 201
 202   // Get input pointer
 203   InputImagePointer input = dynamic_cast<InputImageType*>(itk::ProcessObject::GetInput(0));
 204   static const unsigned int dim = InputImageType::ImageDimension;
 205
 206   // Create main Resample Image Filter
 207   typedef itk::ResampleImageFilter<InputImageType,OutputImageType> FilterType;
 208   typename FilterType::Pointer filter = FilterType::New();
 209   filter->GraftOutput(this->GetOutput());
 210   this->GetOutput()->SetBufferedRegion(this->GetOutput()->GetLargestPossibleRegion());
 211
 212   // Print options if needed
 213   if (m_VerboseOptions) {
 214     std::cout << "Output Spacing = " << m_OutputSpacing << std::endl
 215               << "Output Size    = " << m_OutputSize << std::endl
 216               << "Gaussian       = " << m_GaussianFilteringEnabled << std::endl;
 217     if (m_GaussianFilteringEnabled)
 218       std::cout << "Sigma          = " << m_GaussianSigma << std::endl;
 219     std::cout << "Interpol       = ";
 220     switch (m_InterpolationType) {
 221     case NearestNeighbor: std::cout << "NearestNeighbor" << std::endl; break;
 222     case Linear: std::cout << "Linear" << std::endl; break;
 223     case BSpline: std::cout << "BSpline " << m_BSplineOrder << std::endl; break;
 224     case B_LUT: std::cout << "B-LUT " << m_BSplineOrder << " " << m_BLUTSamplingFactor << std::endl; break;
 225     case WSINC: std::cout << "Windowed Sinc" << std::endl; break;
 226     }
 227 #if ITK_VERSION_MAJOR <= 4
 228     std::cout << "Threads        = " << this->GetNumberOfThreads() << std::endl;
 229 #else
 230     std::cout << "Threads        = " << this->GetNumberOfWorkUnits() << std::endl;
 231 #endif
 232     std::cout << "LastDimIsTime  = " << m_LastDimensionIsTime << std::endl;
 233   }
 234
 235   // Compute origin based on image corner
 236   for(unsigned int i=0; i<OutputImageType::ImageDimension; i++) {
 237     m_OutputOrigin[i] -= 0.5 * input->GetSpacing()[i];
 238     m_OutputOrigin[i] += 0.5 * m_OutputSpacing[i];
 239   }
 240
 241   // Instance of the transform object to be passed to the resample
 242   // filter. By default, identity transform is applied
 243   filter->SetTransform(m_Transform);
 244   filter->SetSize(m_OutputSize);
 245   filter->SetOutputSpacing(m_OutputSpacing);
 246   filter->SetOutputOrigin(m_OutputOrigin);
 247   filter->SetDefaultPixelValue(m_DefaultPixelValue);
 248 #if ITK_VERSION_MAJOR <= 4
 249   filter->SetNumberOfThreads(this->GetNumberOfThreads());
 250 #else
 251   filter->SetNumberOfWorkUnits(this->GetNumberOfWorkUnits());
 252 #endif
 253   filter->SetOutputDirection(m_OutputDirection); // <-- NEEDED if we want to keep orientation (in case of PermutAxes for example)
 254
 255   // Select interpolator
 256   switch (m_InterpolationType) {
 257   case NearestNeighbor: {
 258     typedef itk::NearestNeighborInterpolateImageFunction<InputImageType, double> InterpolatorType;
 259     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 260     filter->SetInterpolator(interpolator);
 261     break;
 262   }
 263   case Linear: {
 264     typedef itk::LinearInterpolateImageFunction<InputImageType, double> InterpolatorType;
 265     typename InterpolatorType::Pointer interpolator =  InterpolatorType::New();
 266     filter->SetInterpolator(interpolator);
 267     break;
 268   }
 269   case BSpline: {
 270     typedef itk::BSplineInterpolateImageFunction<InputImageType, double> InterpolatorType;
 271     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 272     interpolator->SetSplineOrder(m_BSplineOrder);
 273     filter->SetInterpolator(interpolator);
 274     break;
 275   }
 276   case B_LUT: {
 277     typedef itk::BSplineInterpolateImageFunctionWithLUT<InputImageType, double> InterpolatorType;
 278     typename InterpolatorType::Pointer interpolator = InterpolatorType::New();
 279     interpolator->SetSplineOrder(m_BSplineOrder);
 280     interpolator->SetLUTSamplingFactor(m_BLUTSamplingFactor);
 281     filter->SetInterpolator(interpolator);
 282     break;
 283   }
 284   case WSINC: {
 285     typedef itk::WindowedSincInterpolateImageFunction<InputImageType, 4> InterpolatorType;
 286     typename InterpolatorType::Pointer interpolator =  InterpolatorType::New();
 287     filter->SetInterpolator(interpolator);
 288     break;
 289   }
 290   }
 291
 292   // Initial Gaussian blurring if needed
 293   // TODO : replace by itk::DiscreteGaussianImageFilter for small sigma
 294   typedef itk::RecursiveGaussianImageFilter<InputImageType, InputImageType> GaussianFilterType;
 295   std::vector<typename GaussianFilterType::Pointer> gaussianFilters;
 296   if (m_GaussianFilteringEnabled) {
 297     for(unsigned int i=0; i<dim; i++) {
 298       if (m_GaussianSigma[i] != 0) {
 299         gaussianFilters.push_back(GaussianFilterType::New());
 300         gaussianFilters[i]->SetDirection(i);
 301         gaussianFilters[i]->SetOrder(GaussianFilterType::ZeroOrder);
 302         gaussianFilters[i]->SetNormalizeAcrossScale(false);
 303         gaussianFilters[i]->SetSigma(m_GaussianSigma[i]); // in millimeter !
 304         if (gaussianFilters.size() == 1) { // first
 305           gaussianFilters[0]->SetInput(input);
 306         } else {
 307           gaussianFilters[i]->SetInput(gaussianFilters[i-1]->GetOutput());
 308         }
 309       }
 310     }
 311     if (gaussianFilters.size() > 0) {
 312       filter->SetInput(gaussianFilters[gaussianFilters.size()-1]->GetOutput());
 313     } else filter->SetInput(input);
 314   } else filter->SetInput(input);
 315
 316   // Go !
 317   filter->Update();
 318
 319   // Set output
 320   this->GraftOutput(filter->GetOutput());
 321 }
 322 //--------------------------------------------------------------------
 323
 324
 325 //--------------------------------------------------------------------
 326 template<class InputImageType>
 327 typename InputImageType::Pointer
 328 clitk::ResampleImageSpacing(typename InputImageType::Pointer input,
 329                             typename InputImageType::SpacingType spacing,
 330                             int interpolationType)
 331 {
 332   typedef clitk::ResampleImageWithOptionsFilter<InputImageType> ResampleFilterType;
 333   typename ResampleFilterType::Pointer resampler = ResampleFilterType::New();
 334   resampler->SetInput(input);
 335   resampler->SetOutputSpacing(spacing);
 336   typename ResampleFilterType::InterpolationTypeEnumeration inter=ResampleFilterType::NearestNeighbor;
 337   switch(interpolationType) {
 338   case 0: inter = ResampleFilterType::NearestNeighbor; break;
 339   case 1: inter = ResampleFilterType::Linear; break;
 340   case 2: inter = ResampleFilterType::BSpline; break;
 341   case 3: inter = ResampleFilterType::B_LUT; break;
 342   case 4: inter = ResampleFilterType::WSINC; break;
 343   }
 344   resampler->SetInterpolationType(inter);
 345   resampler->SetGaussianFilteringEnabled(true);
 346   resampler->Update();
 347   return resampler->GetOutput();
 348 }
 349 //--------------------------------------------------------------------