itkInterpolateImagePointsFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkInterpolateImagePointsFilter_h
#define itkInterpolateImagePointsFilter_h

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

namespace itk
{
template< typename TInputImage,
          typename TOutputImage,
          typename TCoordType = typename TInputImage::PixelType,
          typename InterpolatorType = BSplineInterpolateImageFunction< TInputImage, TCoordType > >
class 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() ITK_OVERRIDE;

  void GenerateInputRequestedRegion() ITK_OVERRIDE;

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( InputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< typename TInputImage::PixelType > ) );
  // End concept checking
#endif

protected:
  InterpolateImagePointsFilter();
  // ~InterpolateImagePointsFilter(){} default implemnetation ok

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

  void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
                            ThreadIdType threadId) ITK_OVERRIDE;

  void BeforeThreadedGenerateData() ITK_OVERRIDE;

  virtual void VerifyInputInformation() ITK_OVERRIDE {}

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.hxx"
#endif

#endif