itkResampleImageFilter.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 itkResampleImageFilter_h
#define itkResampleImageFilter_h
 
#include "itkFixedArray.h"
#include "itkTransform.h"
#include "itkImageRegionIterator.h"
#include "itkImageToImageFilter.h"
#include "itkExtrapolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkSize.h"
#include "itkDefaultConvertPixelTraits.h"
#include "itkDataObjectDecorator.h"
 
 
namespace itk
{
template <typename TInputImage,
          typename TOutputImage,
          typename TInterpolatorPrecisionType = double,
          typename TTransformPrecisionType = TInterpolatorPrecisionType>
class ITK_TEMPLATE_EXPORT ResampleImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ResampleImageFilter);

  using Self = ResampleImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using InputImageRegionType = typename InputImageType::RegionType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ResampleImageFilter);

  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
 
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr unsigned int ImageDimension = OutputImageDimension; // For backward compatibility
#endif

  using ImageBaseType = ImageBase<Self::OutputImageDimension>;

  using TransformType = Transform<TTransformPrecisionType, Self::OutputImageDimension, Self::InputImageDimension>;
  using TransformPointerType = typename TransformType::ConstPointer;
  using DecoratedTransformType = DataObjectDecorator<TransformType>;
  using DecoratedTransformPointer = typename DecoratedTransformType::Pointer;
 

  using InterpolatorType = InterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>;
  using InterpolatorPointerType = typename InterpolatorType::Pointer;
 
  using InterpolatorOutputType = typename InterpolatorType::OutputType;
 
  using InterpolatorConvertType = DefaultConvertPixelTraits<InterpolatorOutputType>;
 
  using ComponentType = typename InterpolatorConvertType::ComponentType;
 
  using LinearInterpolatorType = LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType>;
  using LinearInterpolatorPointerType = typename LinearInterpolatorType::Pointer;

  using ExtrapolatorType = ExtrapolateImageFunction<InputImageType, TInterpolatorPrecisionType>;
  using ExtrapolatorPointerType = typename ExtrapolatorType::Pointer;

  using SizeType = Size<Self::OutputImageDimension>;

  using IndexType = typename TOutputImage::IndexType;

  using InputPointType = typename InterpolatorType::PointType;
  using OutputPointType = typename TOutputImage::PointType;

  using PixelType = typename TOutputImage::PixelType;
  using InputPixelType = typename TInputImage::PixelType;
 
  using PixelConvertType = DefaultConvertPixelTraits<PixelType>;
 
  using PixelComponentType = typename PixelConvertType::ComponentType;

  using ContinuousInputIndexType = ContinuousIndex<TInterpolatorPrecisionType, InputImageDimension>;

  using OutputImageRegionType = typename TOutputImage::RegionType;

  using SpacingType = typename TOutputImage::SpacingType;
  using OriginPointType = typename TOutputImage::PointType;
  using DirectionType = typename TOutputImage::DirectionType;

  using ReferenceImageBaseType = ImageBase<OutputImageDimension>;
 
  /* See superclass for doxygen. This method adds the additional check
   * that the output space is set */
  void
  VerifyPreconditions() const override;

  itkSetGetDecoratedObjectInputMacro(Transform, TransformType);

  itkSetObjectMacro(Interpolator, InterpolatorType);
  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  itkSetObjectMacro(Extrapolator, ExtrapolatorType);
  itkGetModifiableObjectMacro(Extrapolator, ExtrapolatorType);

  itkSetMacro(Size, SizeType);
  itkGetConstReferenceMacro(Size, SizeType);

  itkSetMacro(DefaultPixelValue, PixelType);
  itkGetConstReferenceMacro(DefaultPixelValue, PixelType);

  itkSetMacro(OutputSpacing, SpacingType);
  virtual void
  SetOutputSpacing(const double * spacing);

  itkGetConstReferenceMacro(OutputSpacing, SpacingType);

  itkSetMacro(OutputOrigin, OriginPointType);
  virtual void
  SetOutputOrigin(const double * origin);

  itkGetConstReferenceMacro(OutputOrigin, OriginPointType);

  itkSetMacro(OutputDirection, DirectionType);
  itkGetConstReferenceMacro(OutputDirection, DirectionType);

  void
  SetOutputParametersFromImage(const ImageBaseType * image);

  itkSetMacro(OutputStartIndex, IndexType);

  itkGetConstReferenceMacro(OutputStartIndex, IndexType);

  itkSetInputMacro(ReferenceImage, ReferenceImageBaseType);

  itkGetInputMacro(ReferenceImage, ReferenceImageBaseType);

  itkSetMacro(UseReferenceImage, bool);
  itkBooleanMacro(UseReferenceImage);
  itkGetConstMacro(UseReferenceImage, bool);
 
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<PixelComponentType>));
 
protected:
  ResampleImageFilter();
  ~ResampleImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  VerifyInputInformation() const override
  {}

  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;

  void
  BeforeThreadedGenerateData() override;

  void
  AfterThreadedGenerateData() override;

  ModifiedTimeType
  GetMTime() const override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
 

  virtual void
  NonlinearThreadedGenerateData(const OutputImageRegionType & outputRegionForThread);

  virtual void
  LinearThreadedGenerateData(const OutputImageRegionType & outputRegionForThread);
 
#if !defined(ITK_LEGACY_REMOVE)
  itkLegacyMacro(virtual PixelType CastPixelWithBoundsChecking(const InterpolatorOutputType value,
                                                               const ComponentType          minComponent,
                                                               const ComponentType          maxComponent) const;)
#endif
 
private:
  static PixelComponentType
  CastComponentWithBoundsChecking(const PixelComponentType value);
 
  template <typename TComponent>
  static PixelComponentType
  CastComponentWithBoundsChecking(const TComponent value);
 
  static PixelType
  CastPixelWithBoundsChecking(const ComponentType value);
 
  template <typename TPixel>
  static PixelType
  CastPixelWithBoundsChecking(const TPixel value);
 
  void
  InitializeTransform();
 
  SizeType                m_Size{};         // Size of the output image
  InterpolatorPointerType m_Interpolator{}; // Image function for
                                            // interpolation
  ExtrapolatorPointerType m_Extrapolator{}; // Image function for
                                            // extrapolation
  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 image start index
  bool            m_UseReferenceImage{ false };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkResampleImageFilter.hxx"
#endif
 
#endif