itkResampleImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkResampleImageFilter_h
#define __itkResampleImageFilter_h

#include "itkFixedArray.h"
#include "itkTransform.h"
#include "itkImageRegionIterator.h"
#include "itkImageToImageFilter.h"
#include "itkExtrapolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkSize.h"
#include "itkDefaultConvertPixelTraits.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 typename InterpolatorType::OutputType InterpolatorOutputType;

  typedef DefaultConvertPixelTraits< InterpolatorOutputType >        InterpolatorConvertType;

  typedef typename InterpolatorConvertType::ComponentType            ComponentType;

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

  typedef ExtrapolateImageFunction< InputImageType,
                                    TInterpolatorPrecisionType >     ExtrapolatorType;
  typedef typename ExtrapolatorType::Pointer ExtrapolatorPointerType;

  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 DefaultConvertPixelTraits<PixelType> PixelConvertType;

  typedef typename PixelConvertType::ComponentType PixelComponentType;

  typedef ContinuousIndex< TInterpolatorPrecisionType, ImageDimension >
                                           ContinuousInputIndexType;

  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);

  itkSetObjectMacro(Extrapolator, ExtrapolatorType);

  itkGetConstObjectMacro(Extrapolator, ExtrapolatorType);

  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();

  ModifiedTimeType GetMTime(void) const;

#ifdef ITK_USE_CONCEPT_CHECKING

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

#endif

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


  virtual void VerifyInputInformation() {}

  virtual void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
                            ThreadIdType threadId);

  virtual void NonlinearThreadedGenerateData(const OutputImageRegionType &
                                     outputRegionForThread,
                                     ThreadIdType threadId);

  virtual void LinearThreadedGenerateData(const OutputImageRegionType &
                                  outputRegionForThread,
                                  ThreadIdType threadId);

  virtual PixelType CastPixelWithBoundsChecking( const InterpolatorOutputType value,
                                                 const ComponentType minComponent,
                                                 const ComponentType maxComponent) const;

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;         // Transform
  InterpolatorPointerType m_Interpolator;      // Image function for
                                               // interpolation
  ExtrapolatorPointerType m_Extrapolator;      // Image function for
                                               // extrapolation
  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;

};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkResampleImageFilter.hxx"
#endif

#endif