itkRayCastInterpolateImageFunction.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 itkRayCastInterpolateImageFunction_h
#define itkRayCastInterpolateImageFunction_h
 
#include "itkInterpolateImageFunction.h"
#include "itkTransform.h"
#include "itkNumericTraits.h"
 
namespace itk
{
template <typename TInputImage, typename TCoordinate = double>
class ITK_TEMPLATE_EXPORT RayCastInterpolateImageFunction : public InterpolateImageFunction<TInputImage, TCoordinate>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RayCastInterpolateImageFunction);

  using Self = RayCastInterpolateImageFunction;
  using Superclass = InterpolateImageFunction<TInputImage, TCoordinate>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;

  using TransformType = Transform<TCoordinate, 3, 3>;
 
  using TransformPointer = typename TransformType::Pointer;
  using InputPointType = typename TransformType::InputPointType;
  using OutputPointType = typename TransformType::OutputPointType;
  using TransformParametersType = typename TransformType::ParametersType;
  using TransformJacobianType = typename TransformType::JacobianType;
 
  using PixelType = typename Superclass::InputPixelType;
 
  using SizeType = typename TInputImage::SizeType;
 
  using DirectionType = Vector<TCoordinate, 3>;

  using InterpolatorType = InterpolateImageFunction<TInputImage, TCoordinate>;
 
  using InterpolatorPointer = typename InterpolatorType::Pointer;

  itkOverrideGetNameOfClassMacro(RayCastInterpolateImageFunction);

  itkNewMacro(Self);

  using typename Superclass::OutputType;

  using typename Superclass::InputImageType;

  using typename Superclass::RealType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using typename Superclass::PointType;

  using typename Superclass::IndexType;

  using typename Superclass::ContinuousIndexType;

  OutputType
  Evaluate(const PointType & point) const override;

  OutputType
  EvaluateAtContinuousIndex(const ContinuousIndexType & index) const override;

  itkSetObjectMacro(Transform, TransformType);
  itkGetModifiableObjectMacro(Transform, TransformType);

  itkSetObjectMacro(Interpolator, InterpolatorType);

  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  itkSetMacro(FocalPoint, InputPointType);
  itkGetConstMacro(FocalPoint, InputPointType);

  itkSetMacro(Threshold, double);
  itkGetConstMacro(Threshold, double);

  bool
  IsInsideBuffer(const PointType &) const override
  {
    return true;
  }
 
  bool
  IsInsideBuffer(const ContinuousIndexType &) const override
  {
    return true;
  }
 
  bool
  IsInsideBuffer(const IndexType &) const override
  {
    return true;
  }
 
  SizeType
  GetRadius() const override
  {
    const InputImageType * input = this->GetInputImage();
    if (!input)
    {
      itkExceptionMacro("Input image required!");
    }
    return input->GetLargestPossibleRegion().GetSize();
  }
 
protected:
  RayCastInterpolateImageFunction();
  ~RayCastInterpolateImageFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  TransformPointer    m_Transform{};
  InputPointType      m_FocalPoint{};
  double              m_Threshold{};
  InterpolatorPointer m_Interpolator{};
 
private:
  class RayCastHelper;
};
} // namespace itk
 

class RayCastHelperEnums
{
public:
  enum class TraversalDirection : uint8_t
  {
    UNDEFINED_DIRECTION = 0, 
    TRANSVERSE_IN_X,         
    TRANSVERSE_IN_Y,         
    TRANSVERSE_IN_Z,         
    LAST_DIRECTION
  };
};
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRayCastInterpolateImageFunction.hxx"
#endif
 
#endif