itkOptResampleImageFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkOptResampleImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-09-16 15:34:33 $
  Version:   $Revision: 1.8 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkOptResampleImageFilter_h
#define __itkOptResampleImageFilter_h

#include "itkFixedArray.h"
#include "itkTransform.h"
#include "itkImageFunction.h"
#include "itkImageRegionIterator.h"
#include "itkImageToImageFilter.h"
#include "itkInterpolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkBSplineInterpolateImageFunction.h"
#include "itkSize.h"

namespace itk
{

template <class TInputImage,
          class TOutputImage,
          class TInterpolatorPrecisionType=double>
class ITK_EXPORT ResampleImageFilter:
    public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef ResampleImageFilter                           Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>  Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  typedef TInputImage                             InputImageType;
  typedef TOutputImage                            OutputImageType;
  typedef typename InputImageType::Pointer        InputImagePointer;
  typedef typename InputImageType::ConstPointer   InputImageConstPointer;
  typedef typename OutputImageType::Pointer       OutputImagePointer;
  typedef typename InputImageType::RegionType     InputImageRegionType;

  itkNewMacro(Self);

  itkTypeMacro(ResampleImageFilter, ImageToImageFilter);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TOutputImage::ImageDimension);
  itkStaticConstMacro(InputImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef ImageBase<itkGetStaticConstMacro(ImageDimension)> ImageBaseType;

  typedef Transform<TInterpolatorPrecisionType,
                    itkGetStaticConstMacro(ImageDimension),
                    itkGetStaticConstMacro(ImageDimension)>       TransformType;
  typedef typename TransformType::ConstPointer             TransformPointerType;

  typedef InterpolateImageFunction<InputImageType,
                        TInterpolatorPrecisionType>     InterpolatorType;
  typedef typename InterpolatorType::Pointer            InterpolatorPointerType;

  typedef LinearInterpolateImageFunction<InputImageType,
                TInterpolatorPrecisionType>   LinearInterpolatorType;
  typedef typename LinearInterpolatorType::Pointer
                                              LinearInterpolatorPointerType;

  typedef BSplineInterpolateImageFunction<InputImageType,
                TInterpolatorPrecisionType>   BSplineInterpolatorType;
  typedef typename BSplineInterpolatorType::Pointer
                                              BSplineInterpolatorPointerType;

  typedef Size<itkGetStaticConstMacro(ImageDimension)>  SizeType;

  typedef typename TOutputImage::IndexType              IndexType;

  typedef typename InterpolatorType::PointType          PointType;
  //typedef typename TOutputImage::PointType            PointType;

  typedef typename TOutputImage::PixelType              PixelType;
  typedef typename TInputImage::PixelType               InputPixelType;

  typedef typename TOutputImage::RegionType             OutputImageRegionType;

  typedef typename TOutputImage::SpacingType            SpacingType;
  typedef typename TOutputImage::PointType              OriginPointType;
  typedef typename TOutputImage::DirectionType          DirectionType;

  itkSetConstObjectMacro( Transform, TransformType );

  itkGetConstObjectMacro( Transform, TransformType );

  itkSetObjectMacro( Interpolator, InterpolatorType );

  itkGetConstObjectMacro( Interpolator, InterpolatorType );

  itkSetMacro( Size, SizeType );

  itkGetConstReferenceMacro( Size, SizeType );

  itkSetMacro(DefaultPixelValue,PixelType);

  itkGetConstReferenceMacro(DefaultPixelValue,PixelType);

  itkSetMacro(OutputSpacing, SpacingType);
  virtual void SetOutputSpacing( const double* values);

  itkGetConstReferenceMacro( OutputSpacing, SpacingType );

  itkSetMacro(OutputOrigin, OriginPointType);
  virtual void SetOutputOrigin( const double* values);

  itkGetConstReferenceMacro( OutputOrigin, OriginPointType );

  itkSetMacro(OutputDirection, DirectionType);
  itkGetConstReferenceMacro(OutputDirection, DirectionType);

  void SetOutputParametersFromImage ( const ImageBaseType * image );

  itkSetMacro( OutputStartIndex, IndexType );

  itkGetConstReferenceMacro( OutputStartIndex, IndexType );

  void SetReferenceImage ( const TOutputImage *image );
  const TOutputImage * GetReferenceImage() const;

  itkSetMacro(UseReferenceImage, bool);
  itkBooleanMacro(UseReferenceImage);
  itkGetConstMacro(UseReferenceImage, bool);

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

  virtual void BeforeThreadedGenerateData();

  virtual void AfterThreadedGenerateData();

  unsigned long GetMTime( void ) const;

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(OutputHasNumericTraitsCheck,
                  (Concept::HasNumericTraits<PixelType>));

#endif

protected:
  ResampleImageFilter();
  ~ResampleImageFilter() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread,
                            int threadId );

  void NonlinearThreadedGenerateData(const OutputImageRegionType &
                                           outputRegionForThread,
                                     int threadId );

  void LinearThreadedGenerateData(const OutputImageRegionType &
                                        outputRegionForThread,
                                  int threadId );


private:
  ResampleImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  SizeType                m_Size;              // Size of the output image
  TransformPointerType    m_Transform;         // Coordinate transform to use
  InterpolatorPointerType m_Interpolator;      // Image function for
                                               // interpolation
  PixelType               m_DefaultPixelValue; // default pixel value
                                               // if the point is
                                               // outside the image
  SpacingType             m_OutputSpacing;     // output image spacing
  OriginPointType         m_OutputOrigin;      // output image origin
  DirectionType           m_OutputDirection;   // output image direction cosines
  IndexType               m_OutputStartIndex;  // output image start index
  bool                    m_UseReferenceImage;

  bool                             m_InterpolatorIsLinear;
  LinearInterpolatorPointerType    m_LinearInterpolator;
  bool                             m_InterpolatorIsBSpline;
  BSplineInterpolatorPointerType   m_BSplineInterpolator;

};


} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkOptResampleImageFilter.txx"
#endif

#endif