itkExponentialDeformationFieldImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkExponentialDeformationFieldImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-02-20 17:34:50 $
  Version:   $Revision: 1.3 $

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

#include "itkImageToImageFilter.h"
#include "itkDivideByConstantImageFilter.h"
#include "itkCastImageFilter.h"
#include "itkWarpVectorImageFilter.h"
#include "itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h"
#include "itkAddImageFilter.h"


namespace itk
{

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

  itkNewMacro(Self);

  itkTypeMacro(ExponentialDeformationFieldImageFilter, ImageToImageFilter);

  typedef TInputImage                                  InputImageType;
  typedef typename InputImageType::Pointer             InputImagePointer;
  typedef typename InputImageType::ConstPointer        InputImageConstPointer;
  typedef typename InputImageType::PixelType           InputPixelType;
  typedef typename InputPixelType::RealValueType       InputPixelRealValueType;

  typedef TOutputImage                                 OutputImageType;
  typedef typename OutputImageType::Pointer            OutputImagePointer;
  typedef typename OutputImageType::PixelType          OutputPixelType;

  itkSetMacro(MaximumNumberOfIterations, unsigned int);
  itkGetMacro(MaximumNumberOfIterations, unsigned int);

  itkSetMacro( AutomaticNumberOfIterations, bool );
  itkGetMacro( AutomaticNumberOfIterations, bool );
  itkBooleanMacro(AutomaticNumberOfIterations);

  itkSetMacro( ComputeInverse, bool );
  itkGetMacro( ComputeInverse, bool );
  itkBooleanMacro(ComputeInverse);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int,
                      TInputImage::ImageDimension );
  itkStaticConstMacro(PixelDimension, unsigned int,
                      InputPixelType::Dimension );
  itkStaticConstMacro(OutputPixelDimension, unsigned int,
                      OutputPixelType::Dimension );


#ifdef ITK_USE_CONCEPT_CHECKING

   itkConceptMacro(OutputHasNumericTraitsCheck,
                   (Concept::HasNumericTraits<typename OutputPixelType::ValueType>));
   itkConceptMacro(SameDimensionCheck1,
                   (Concept::SameDimension<ImageDimension,OutputImageDimension>));
   itkConceptMacro(SameDimensionCheck2,
                   (Concept::SameDimension<ImageDimension,PixelDimension>));
   itkConceptMacro(SameDimensionCheck3,
                   (Concept::SameDimension<ImageDimension,OutputPixelDimension>));

#endif

protected:
  ExponentialDeformationFieldImageFilter();
  virtual ~ExponentialDeformationFieldImageFilter() {};

  void PrintSelf(std::ostream& os, Indent indent) const;

  void GenerateData();

  typedef typename InputImageType::RegionType          RegionType;

  typedef DivideByConstantImageFilter<
    InputImageType,
    InputPixelRealValueType, OutputImageType >         DivideByConstantType;

  typedef CastImageFilter<
    InputImageType, OutputImageType>                   CasterType;

  typedef WarpVectorImageFilter<
    OutputImageType,
    OutputImageType, OutputImageType>                  VectorWarperType;

  typedef VectorLinearInterpolateNearestNeighborExtrapolateImageFunction<
    OutputImageType,double>                            FieldInterpolatorType;

  typedef AddImageFilter<
    OutputImageType, OutputImageType, OutputImageType> AdderType;

  typedef typename DivideByConstantType::Pointer       DivideByConstantPointer;
  typedef typename CasterType::Pointer                 CasterPointer;
  typedef typename VectorWarperType::Pointer           VectorWarperPointer;
  typedef typename FieldInterpolatorType::Pointer      FieldInterpolatorPointer;
  typedef typename FieldInterpolatorType::OutputType   FieldInterpolatorOutputType;
  typedef typename AdderType::Pointer                  AdderPointer;


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

  bool                       m_AutomaticNumberOfIterations;
  unsigned int               m_MaximumNumberOfIterations;

  bool                       m_ComputeInverse;

  DivideByConstantPointer    m_Divider;
  CasterPointer              m_Caster;
  VectorWarperPointer        m_Warper;
  AdderPointer               m_Adder;
};


} // end namespace itk

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

#endif