itkInterpolateImagePointsFilter.h

Go to the documentation of this file.

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

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

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.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 __itkInterpolateImagePointsFilter_h
#define __itkInterpolateImagePointsFilter_h

#include "itkBSplineInterpolateImageFunction.h"
#include "itkImageToImageFilter.h"
#include "itkImageToImageFilterDetail.h"
#include "itkImageRegionIterator.h"
#include "itkImageRegionConstIterator.h"

namespace itk
{
template <class TInputImage, 
          class TOutputImage, 
          class TCoordType = ITK_TYPENAME TInputImage::PixelType, 
          class InterpolatorType = BSplineInterpolateImageFunction<TInputImage, TCoordType> > 
class ITK_EXPORT InterpolateImagePointsFilter : 
    public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef InterpolateImagePointsFilter                  Self;
  typedef ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkTypeMacro(InterpolateImagePointsFilter, ImageToImageFilter);

 
  itkNewMacro( Self );

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

  typedef typename Superclass::InputImageType    InputImageType;
  typedef typename Superclass::OutputImageType   OutputImageType;
  typedef typename Superclass::InputImagePointer InputImagePointer;

  typedef typename TOutputImage::Pointer       OutputImagePointer;
  typedef ImageRegionIterator<InputImageType>  OutputImageIterator;
  typedef typename OutputImageType::RegionType OutputImageRegionType;

  typedef typename TOutputImage::PixelType   PixelType;

  typedef typename InterpolatorType::Pointer              InterpolatorPointer;
  typedef typename InterpolatorType::ContinuousIndexType  ContinuousIndexType;

  typedef Image< TCoordType, itkGetStaticConstMacro(ImageDimension) > CoordImageType;

  typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(ImageDimension),itkGetStaticConstMacro(ImageDimension)>     RegionCopierType; 

  void SetInputImage (const TInputImage * inputImage);

  void SetInterpolationCoordinate (const CoordImageType * coordinate, unsigned int setDimension);

  itkSetMacro(DefaultPixelValue,PixelType);

  itkGetConstMacro(DefaultPixelValue,PixelType);

  InterpolatorPointer GetInterpolator()
    { return m_Interpolator; }

  void GenerateOutputInformation();

  void GenerateInputRequestedRegion();

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(InputHasNumericTraitsCheck,
    (Concept::HasNumericTraits<typename TInputImage::PixelType>));

#endif

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

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

  typedef typename CoordImageType::Pointer         CoordImageTypePointer;
  typedef ImageRegionConstIterator<CoordImageType> CoordImageIterator;
  typedef typename CoordImageType::RegionType      CoordImageRegionType;

  InterpolateImagePointsFilter( const Self& ); //purposely not implemented
  void operator=( const Self& ); //purposely not implemented

  InterpolatorPointer      m_Interpolator;
  PixelType                m_DefaultPixelValue; // default pixel value if the
                                                // point is outside the image
};

} // namespace itk

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

#endif