itkBSplineControlPointImageFilter.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 itkBSplineControlPointImageFilter_h
#define itkBSplineControlPointImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkBSplineKernelFunction.h"
#include "itkCoxDeBoorBSplineKernelFunction.h"
#include "itkFixedArray.h"
#include "itkPointSet.h"
#include "itkVariableSizeMatrix.h"
#include "itkVector.h"
#include "itkVectorContainer.h"
 
#include "vnl/vnl_matrix.h"
#include "vnl/vnl_vector.h"
 
namespace itk
{

 
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT BSplineControlPointImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BSplineControlPointImageFilter);
 
  using Self = BSplineControlPointImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BSplineControlPointImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
 
  using ControlPointLatticeType = TInputImage;
  using OutputImageType = TOutputImage;

  using PixelType = typename OutputImageType::PixelType;
  using RegionType = typename OutputImageType::RegionType;
  using IndexType = typename OutputImageType::IndexType;
  using PointType = typename OutputImageType::PointType;
  using OutputImageRegionType = typename OutputImageType::RegionType;
 
  using SpacingType = typename OutputImageType::SpacingType;
  using OriginType = typename OutputImageType::PointType;
  using SizeType = typename OutputImageType::SizeType;
  using DirectionType = typename OutputImageType::DirectionType;

  using RealType = float;
  using RealImageType = Image<RealType, Self::ImageDimension>;
  using RealImagePointer = typename RealImageType::Pointer;
 
  using ArrayType = FixedArray<unsigned int, Self::ImageDimension>;
  using RealArrayType = FixedArray<RealType, Self::ImageDimension>;

  using PointSetType = PointSet<PixelType, Self::ImageDimension>;
  using PointDataType = typename PointSetType::PixelType;
  using PointDataContainerType = typename PointSetType::PointDataContainer;
  using PointDataImageType = Image<PointDataType, Self::ImageDimension>;
  using PointDataImagePointer = typename PointDataImageType::Pointer;

  using KernelType = CoxDeBoorBSplineKernelFunction<3>;
  using KernelOrder0Type = BSplineKernelFunction<0>;
  using KernelOrder1Type = BSplineKernelFunction<1>;
  using KernelOrder2Type = BSplineKernelFunction<2>;
  using KernelOrder3Type = BSplineKernelFunction<3>;

  void
  SetSplineOrder(unsigned int);

  void SetSplineOrder(ArrayType);

  itkGetConstReferenceMacro(SplineOrder, ArrayType);

  itkSetMacro(CloseDimension, ArrayType);
  itkGetConstReferenceMacro(CloseDimension, ArrayType);

  itkSetMacro(Spacing, SpacingType);
  itkGetConstMacro(Spacing, SpacingType);

  itkSetMacro(Origin, OriginType);
  itkGetConstMacro(Origin, OriginType);

  itkSetMacro(Size, SizeType);
  itkGetConstMacro(Size, SizeType);

  itkSetMacro(Direction, DirectionType);

  itkGetConstMacro(Direction, DirectionType);

  typename ControlPointLatticeType::Pointer RefineControlPointLattice(ArrayType);
 
protected:
  BSplineControlPointImageFilter();
  ~BSplineControlPointImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType &) override;
 
 
private:
  void
  BeforeThreadedGenerateData() override;

  unsigned int
  SplitRequestedRegion(unsigned int, unsigned int, OutputImageRegionType &) override;

  void
  CollapsePhiLattice(PointDataImageType *, PointDataImageType *, const RealType, const unsigned int);

  void SetNumberOfLevels(ArrayType);

  SizeType      m_Size{};
  SpacingType   m_Spacing{};
  OriginType    m_Origin{};
  DirectionType m_Direction{};
 
  bool         m_DoMultilevel{ false };
  unsigned int m_MaximumNumberOfLevels{ 1 };
  ArrayType    m_NumberOfControlPoints{};
  ArrayType    m_CloseDimension{};
  ArrayType    m_SplineOrder{};
  ArrayType    m_NumberOfLevels{};
 
  vnl_matrix<RealType> m_RefinedLatticeCoefficients[ImageDimension]{};
 
  typename KernelType::Pointer       m_Kernel[ImageDimension]{};
  typename KernelOrder0Type::Pointer m_KernelOrder0{};
  typename KernelOrder1Type::Pointer m_KernelOrder1{};
  typename KernelOrder2Type::Pointer m_KernelOrder2{};
  typename KernelOrder3Type::Pointer m_KernelOrder3{};
 
  RealType m_BSplineEpsilon{ static_cast<RealType>(1e-3) };
 
  inline typename RealImageType::IndexType
  NumberToIndex(unsigned int number, typename RealImageType::SizeType size)
  {
    typename RealImageType::IndexType k;
    k[0] = 1;
 
    for (unsigned int i = 1; i < ImageDimension; ++i)
    {
      k[i] = size[ImageDimension - i - 1] * k[i - 1];
    }
    typename RealImageType::IndexType index;
    for (unsigned int i = 0; i < ImageDimension; ++i)
    {
      index[ImageDimension - i - 1] = static_cast<unsigned int>(number / k[ImageDimension - i - 1]);
      number %= k[ImageDimension - i - 1];
    }
    return index;
  }
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineControlPointImageFilter.hxx"
#endif
 
#endif