itkWarpImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkWarpImageFilter_h
#define itkWarpImageFilter_h
#include "itkImageBase.h"
#include "itkImageToImageFilter.h"
#include "itkLinearInterpolateImageFunction.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage, typename TDisplacementField>
class ITK_TEMPLATE_EXPORT WarpImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(WarpImageFilter);
  using Self = WarpImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(WarpImageFilter);
 
  using OutputImageRegionType = typename TOutputImage::RegionType;
 
  using typename Superclass::InputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::OutputImageType;
  using typename Superclass::OutputImagePointer;
  using typename Superclass::InputImageConstPointer;
  using IndexType = typename OutputImageType::IndexType;
  using IndexValueType = typename OutputImageType::IndexValueType;
  using SizeType = typename OutputImageType::SizeType;
  using PixelType = typename OutputImageType::PixelType;
  using PixelComponentType = typename OutputImageType::InternalPixelType;
  using SpacingType = typename OutputImageType::SpacingType;
 
  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int DisplacementFieldDimension = TDisplacementField::ImageDimension;
 
  using ImageBaseType = ImageBase<Self::ImageDimension>;
 
  using DisplacementFieldType = TDisplacementField;
  using DisplacementFieldPointer = typename DisplacementFieldType::Pointer;
  using DisplacementType = typename DisplacementFieldType::PixelType;
 
  using CoordinateType = double;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
  using InterpolatorType = InterpolateImageFunction<InputImageType, CoordinateType>;
  using InterpolatorPointer = typename InterpolatorType::Pointer;
  using DefaultInterpolatorType = LinearInterpolateImageFunction<InputImageType, CoordinateType>;
 
  using PointType = Point<CoordinateType, Self::ImageDimension>;
 
  using DirectionType = typename TOutputImage::DirectionType;
 
 
  itkSetInputMacro(DisplacementField, DisplacementFieldType);
 
  itkGetInputMacro(DisplacementField, DisplacementFieldType);
 
  itkSetObjectMacro(Interpolator, InterpolatorType);
  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);
  itkSetMacro(OutputSpacing, SpacingType);
  virtual void
  SetOutputSpacing(const double * spacing);
  itkGetConstReferenceMacro(OutputSpacing, SpacingType);
 
  itkSetMacro(OutputOrigin, PointType);
  virtual void
  SetOutputOrigin(const double * origin);
  itkGetConstReferenceMacro(OutputOrigin, PointType);
 
  itkSetMacro(OutputDirection, DirectionType);
  itkGetConstReferenceMacro(OutputDirection, DirectionType);
  void
  SetOutputParametersFromImage(const ImageBaseType * image);
 
  itkSetMacro(OutputStartIndex, IndexType);
 
  itkGetConstReferenceMacro(OutputStartIndex, IndexType);
 
  itkSetMacro(OutputSize, SizeType);
 
  itkGetConstReferenceMacro(OutputSize, SizeType);
 
  itkSetMacro(EdgePaddingValue, PixelType);
 
  itkGetConstMacro(EdgePaddingValue, PixelType);
 
  void
  GenerateOutputInformation() override;
 
  void
  GenerateInputRequestedRegion() override;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  AfterThreadedGenerateData() override;
 
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro(SameDimensionCheck1, (Concept::SameDimension<ImageDimension, InputImageDimension>));
  itkConceptMacro(SameDimensionCheck2, (Concept::SameDimension<ImageDimension, DisplacementFieldDimension>));
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<typename TInputImage::InternalPixelType>));
  itkConceptMacro(DisplacementFieldHasNumericTraitsCheck,
                  (Concept::HasNumericTraits<typename TDisplacementField::PixelType::ValueType>));
  // End concept checking
#endif
 
protected:
  WarpImageFilter();
  // ~WarpImageFilter() {} default implementation is ok
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 
 
  void
  VerifyInputInformation() const override;
 
  void
  EvaluateDisplacementAtPhysicalPoint(const PointType & point, DisplacementType & output);
 
  void
  EvaluateDisplacementAtPhysicalPoint(const PointType &             point,
                                      const DisplacementFieldType * fieldPtr,
                                      DisplacementType &            output);
 
  bool m_DefFieldSameInformation{};
  // variables for deffield interpolator
  IndexType m_StartIndex, m_EndIndex{};
 
private:
  PixelType     m_EdgePaddingValue{};
  SpacingType   m_OutputSpacing{};
  PointType     m_OutputOrigin{};
  DirectionType m_OutputDirection{};
 
  InterpolatorPointer m_Interpolator{};
  SizeType            m_OutputSize{};       // Size of the output image
  IndexType           m_OutputStartIndex{}; // output image start index
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkWarpImageFilter.hxx"
#endif
 
#endif