itkInverseDeformationFieldImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkInverseDeformationFieldImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-25 12:27:27 $
  Version:   $Revision: 1.5 $

  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 __itkInverseDeformationFieldImageFilter_h
#define __itkInverseDeformationFieldImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkKernelTransform.h"
#include "itkImageRegionConstIteratorWithIndex.h"

namespace itk
{

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

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

  itkNewMacro(Self);  

  itkTypeMacro(InverseDeformationFieldImageFilter, ImageToImageFilter);

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

  typedef KernelTransform<
    double, itkGetStaticConstMacro(ImageDimension)> KernelTransformType;
  typedef typename KernelTransformType::Pointer     KernelTransformPointerType;

  typedef typename OutputImageType::SizeType SizeType;

  typedef typename OutputImageType::IndexType IndexType;

  typedef typename TOutputImage::PixelType     OutputPixelType;
  typedef typename OutputPixelType::ValueType  OutputPixelComponentType;

  typedef typename TOutputImage::RegionType OutputImageRegionType;

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

  itkSetObjectMacro( KernelTransform, KernelTransformType ); 

  itkGetObjectMacro( KernelTransform, KernelTransformType );

  itkSetMacro( Size, SizeType );

  itkGetConstReferenceMacro( Size, SizeType );

  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( SubsamplingFactor, unsigned int );
  itkGetConstMacro( SubsamplingFactor, unsigned int );

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

  unsigned long GetMTime( void ) const;

#ifdef ITK_USE_CONCEPT_CHECKING

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

#endif

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

  void GenerateData();

  void PrepareKernelBaseSpline();

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

  SizeType                      m_Size;              // Size of the output image
  KernelTransformPointerType    m_KernelTransform;   // Coordinate transform to use
  SpacingType                   m_OutputSpacing;     // output image spacing
  OriginPointType               m_OutputOrigin;      // output image origin

  unsigned int                  m_SubsamplingFactor; // factor to subsample the input field.
};

  
} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkInverseDeformationFieldImageFilter.txx"
#endif
  
#endif