itkGridForwardWarpImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGridForwardWarpImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-23 03:43:41 $
  Version:   $Revision: 1.2 $

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

#include "itkImageToImageFilter.h"

namespace itk
{

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

  itkNewMacro(Self);

  itkTypeMacro( GridForwardWarpImageFilter, ImageToImageFilter );

  typedef typename TOutputImage::RegionType                     OutputImageRegionType;

  typedef typename Superclass::OutputImageType                  OutputImageType;
  typedef typename Superclass::OutputImagePointer               OutputImagePointer;
  typedef typename OutputImageType::IndexType                   IndexType;
  typedef typename OutputImageType::SizeType                    SizeType;
  typedef typename OutputImageType::PixelType                   PixelType;
  typedef typename OutputImageType::SpacingType                 SpacingType;

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

  typedef TDeformationField                                   DeformationFieldType;
  typedef typename DeformationFieldType::ConstPointer         DeformationFieldConstPointer;
  typedef typename DeformationFieldType::PixelType            DisplacementType;

  itkSetMacro( BackgroundValue, PixelType );

  itkGetConstMacro( BackgroundValue, PixelType );

  itkSetMacro( ForegroundValue, PixelType );

  itkGetConstMacro( ForegroundValue, PixelType );


#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<ImageDimension, DeformationFieldDimension>));
  itkConceptMacro(DeformationFieldHasNumericTraitsCheck,
    (Concept::HasNumericTraits<typename TDeformationField::PixelType::ValueType>));

#endif

protected:
  GridForwardWarpImageFilter();
  ~GridForwardWarpImageFilter() {};

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

  void GenerateData();

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

  PixelType                  m_BackgroundValue;
  PixelType                  m_ForegroundValue;
  unsigned int               m_GridPixSpacing;
};

} // end namespace itk

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

#endif