itkInterpolateImageFunction.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 itkInterpolateImageFunction_h
#define itkInterpolateImageFunction_h
 
#include "itkImageFunction.h"
 
namespace itk
{
template <typename TInputImage, typename TCoordRep = double>
class ITK_TEMPLATE_EXPORT InterpolateImageFunction
  : public ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordRep>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(InterpolateImageFunction);
 
  using Self = InterpolateImageFunction;
  using Superclass =
    ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordRep>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkOverrideGetNameOfClassMacro(InterpolateImageFunction);
 
  using typename Superclass::OutputType;
 
  using typename Superclass::InputImageType;
 
  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
 
  using typename Superclass::PointType;
 
  using typename Superclass::IndexType;
  using typename Superclass::IndexValueType;
 
  using SizeType = typename InputImageType::SizeType;
 
  using typename Superclass::ContinuousIndexType;
 
  using RealType = typename NumericTraits<typename TInputImage::PixelType>::RealType;
 
  OutputType
  Evaluate(const PointType & point) const override
  {
    const ContinuousIndexType index =
      this->GetInputImage()->template TransformPhysicalPointToContinuousIndex<TCoordRep>(point);
    return (this->EvaluateAtContinuousIndex(index));
  }
  OutputType
  EvaluateAtContinuousIndex(const ContinuousIndexType & index) const override = 0;
 
  OutputType
  EvaluateAtIndex(const IndexType & index) const override
  {
    return (static_cast<RealType>(this->GetInputImage()->GetPixel(index)));
  }
 
#if defined(ITKV4_COMPATIBILITY)
  virtual SizeType
  GetRadius() const
  {
    // if ITKv4 compatibility is enabled then set the radius to the
    // largest by default.
    const InputImageType * input = this->GetInputImage();
    if (!input)
    {
      itkExceptionMacro("Input image required!");
    }
    return input->GetLargestPossibleRegion().GetSize();
  }
#else
  virtual SizeType
  GetRadius() const = 0;
#endif
protected:
  InterpolateImageFunction() = default;
  ~InterpolateImageFunction() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
  }
};
} // end namespace itk
 
#endif