itkWarpImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkWarpImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2002/09/30 15:24:40 $
  Version:   $Revision: 1.12 $

  Copyright (c) 2002 Insight 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 __itkWarpImageFilter_h
#define __itkWarpImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkInterpolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkPoint.h"

namespace itk
{

template <
class TInputImage,
class TOutputImage,
class TDeformationField
>
class ITK_EXPORT WarpImageFilter :
  public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef WarpImageFilter      Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage> Superclass;
  typedef SmartPointer<Self>         Pointer;
  typedef SmartPointer<const Self>   ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( WarpImageFilter, ImageToImageFilter );

  typedef typename TOutputImage::RegionType OutputImageRegionType;

  typedef typename Superclass::InputImageType        InputImageType;
  typedef typename Superclass::InputImagePointer     InputImagePointer;
  typedef typename Superclass::OutputImageType       OutputImageType;
  typedef typename Superclass::OutputImagePointer    OutputImagePointer;
  typedef typename Superclass::InputImageConstPointer InputImageConstPointer;
  typedef typename OutputImageType::IndexType        IndexType;
  typedef typename OutputImageType::SizeType         SizeType;
  typedef typename OutputImageType::PixelType        PixelType;

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

  typedef TDeformationField    DeformationFieldType;
  typedef typename DeformationFieldType::Pointer  DeformationFieldPointer;
  typedef typename DeformationFieldType::PixelType DisplacementType;

  typedef double CoordRepType;
  typedef InterpolateImageFunction<InputImageType,CoordRepType>   InterpolatorType;
  typedef typename InterpolatorType::Pointer   InterpolatorPointer;
  typedef LinearInterpolateImageFunction<InputImageType,CoordRepType>
    DefaultInterpolatorType;

  typedef Point<CoordRepType,itkGetStaticConstMacro(ImageDimension)> PointType;

  void SetDeformationField( DeformationFieldType * field );

  DeformationFieldType * GetDeformationField(void);

  itkSetObjectMacro( Interpolator, InterpolatorType );

  itkGetObjectMacro( Interpolator, InterpolatorType );

  virtual void SetOutputSpacing( const double values[ImageDimension] );

  const double * GetOutputSpacing()
    { return m_OutputSpacing; }

  virtual void SetOutputOrigin( const double values[ImageDimension] );

  const double * GetOutputOrigin()
    { return m_OutputSpacing; }

  itkSetMacro( EdgePaddingValue, PixelType );

  itkGetMacro( EdgePaddingValue, PixelType );

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

  virtual void BeforeThreadedGenerateData();

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

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

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

  PixelType                  m_EdgePaddingValue;
  double                     m_OutputSpacing[ImageDimension];
  double                     m_OutputOrigin[ImageDimension];

  InterpolatorPointer        m_Interpolator;
  
};

} // end namespace itk

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

#endif

---