itkVectorResampleImageFilter.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.
 *
 *=========================================================================*/
#ifndef itkVectorResampleImageFilter_h
#define itkVectorResampleImageFilter_h

#include "itkTransform.h"
#include "itkImageRegionIterator.h"
#include "itkImageToImageFilter.h"
#include "itkVectorInterpolateImageFunction.h"
#include "itkSize.h"

namespace itk
{
template< typename TInputImage, typename TOutputImage, typename TInterpolatorPrecisionType = double >
class VectorResampleImageFilter:
  public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  typedef VectorResampleImageFilter                       Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

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

  itkNewMacro(Self);

  itkTypeMacro(VectorResampleImageFilter, ImageToImageFilter);

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

  typedef Transform< TInterpolatorPrecisionType, itkGetStaticConstMacro(ImageDimension),
                     itkGetStaticConstMacro(ImageDimension) > TransformType;
  typedef typename TransformType::ConstPointer
  TransformPointerType;

  typedef VectorInterpolateImageFunction< InputImageType, TInterpolatorPrecisionType > InterpolatorType;
  typedef typename InterpolatorType::Pointer                                           InterpolatorPointerType;

  typedef Size< itkGetStaticConstMacro(ImageDimension) > SizeType;

  typedef typename TOutputImage::IndexType IndexType;

  typedef typename InterpolatorType::PointType PointType;

  typedef typename TOutputImage::PixelType PixelType;
  typedef typename PixelType::ValueType    PixelComponentType;

  typedef typename TOutputImage::RegionType OutputImageRegionType;

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

  itkSetConstObjectMacro(Transform, TransformType);

  itkSetObjectMacro(Interpolator, InterpolatorType);

  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  itkSetMacro(Size, SizeType);

  itkGetConstReferenceMacro(Size, SizeType);

  itkSetMacro(DefaultPixelValue, PixelType);

  itkGetConstMacro(DefaultPixelValue, PixelType);

  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(OutputDirection, DirectionType);
  itkGetConstReferenceMacro(OutputDirection, DirectionType);

  itkSetMacro(OutputStartIndex, IndexType);

  itkGetConstReferenceMacro(OutputStartIndex, IndexType);

  virtual void GenerateOutputInformation() ITK_OVERRIDE;

  virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;

  virtual void BeforeThreadedGenerateData() ITK_OVERRIDE;

  virtual void AfterThreadedGenerateData() ITK_OVERRIDE;

  ModifiedTimeType GetMTime(void) const ITK_OVERRIDE;

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

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

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

private:
  VectorResampleImageFilter(const Self &) ITK_DELETE_FUNCTION;
  void operator=(const Self &) ITK_DELETE_FUNCTION;

  SizeType                m_Size;       // Size of the output image
  TransformPointerType    m_Transform;  // Coordinate transform to use
  InterpolatorPointerType m_Interpolator;
  // Image function for interpolation
  PixelType m_DefaultPixelValue;
  // default pixel value if the point
  // is outside the image
  SpacingType       m_OutputSpacing;           // output image spacing
  OriginPointType   m_OutputOrigin;            // output image origin
  DirectionType     m_OutputDirection;         // output image direction cosines
  IndexType         m_OutputStartIndex;        // output start index
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkVectorResampleImageFilter.hxx"
#endif

#endif