itkBSplineScatteredDataPointSetToImageFilter.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 itkBSplineScatteredDataPointSetToImageFilter_h
#define itkBSplineScatteredDataPointSetToImageFilter_h
 
#include "itkPointSetToImageFilter.h"
 
#include "itkBSplineKernelFunction.h"
#include "itkCoxDeBoorBSplineKernelFunction.h"
#include "itkVectorContainer.h"
 
#include "vnl/vnl_matrix.h"
 
namespace itk
{
 
template <typename TInputPointSet, typename TOutputImage>
class ITK_TEMPLATE_EXPORT BSplineScatteredDataPointSetToImageFilter
  : public PointSetToImageFilter<TInputPointSet, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BSplineScatteredDataPointSetToImageFilter);

  using Self = BSplineScatteredDataPointSetToImageFilter;
  using Superclass = PointSetToImageFilter<TInputPointSet, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BSplineScatteredDataPointSetToImageFilter);

  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
 
  using ImageType = TOutputImage;
  using PointSetType = TInputPointSet;

  using PixelType = typename ImageType::PixelType;
  using RegionType = typename ImageType::RegionType;
  using OutputImageRegionType = RegionType;
  using SizeType = typename ImageType::SizeType;
  using IndexType = typename ImageType::IndexType;

  using PointType = typename PointSetType::PointType;
  using PointSetPointer = typename PointSetType::Pointer;
  using PointDataType = typename PointSetType::PixelType;
  using PointDataContainerType = typename PointSetType::PointDataContainer;
  using PointDataContainerPointer = typename PointDataContainerType::Pointer;

  using RealType = float;
  using WeightsContainerType = VectorContainer<unsigned int, RealType>;

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

  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(const ArrayType &);

  itkGetConstReferenceMacro(SplineOrder, ArrayType);

  itkSetMacro(NumberOfControlPoints, ArrayType);
  itkGetConstReferenceMacro(NumberOfControlPoints, ArrayType);

  itkGetConstReferenceMacro(CurrentNumberOfControlPoints, ArrayType);

  void
  SetNumberOfLevels(unsigned int);

  void
  SetNumberOfLevels(const ArrayType &);

  itkGetConstReferenceMacro(NumberOfLevels, ArrayType);

  itkSetMacro(BSplineEpsilon, RealType);
  itkGetConstMacro(BSplineEpsilon, RealType);

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

  void
  SetPointWeights(WeightsContainerType * weights);

  itkSetMacro(GenerateOutputImage, bool);
  itkGetConstReferenceMacro(GenerateOutputImage, bool);
  itkBooleanMacro(GenerateOutputImage);

  PointDataImagePointer
  GetPhiLattice()
  {
    return static_cast<PointDataImageType *>(this->ProcessObject::GetOutput(1));
  }
 
protected:
  BSplineScatteredDataPointSetToImageFilter();
  ~BSplineScatteredDataPointSetToImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  ThreadedGenerateData(const RegionType &, ThreadIdType) override;
 
  void
  DynamicThreadedGenerateData(const RegionType &) override
  {
    itkExceptionMacro("This class requires threadId so it must use classic multi-threading model");
  }
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  AfterThreadedGenerateData() override;
 
  unsigned int
  SplitRequestedRegion(unsigned int, unsigned int, RegionType &) override;
 
  void
  GenerateData() override;
 
private:
  void
  RefineControlPointLattice();

  void
  GenerateOutputImage();

  void
  ThreadedGenerateDataForFitting(const RegionType &, ThreadIdType);

  void
  ThreadedGenerateDataForReconstruction(const RegionType &, ThreadIdType);

  void
  ThreadedGenerateDataForUpdatingResidualValues(const RegionType &, ThreadIdType);

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

  void
  SetPhiLatticeParametricDomainParameters();

  IndexType
  NumberToIndex(const unsigned int, const SizeType);
 
  bool         m_DoMultilevel{ false };
  bool         m_GenerateOutputImage{ true };
  bool         m_UsePointWeights{ false };
  unsigned int m_MaximumNumberOfLevels{ 1 };
  unsigned int m_CurrentLevel{ 0 };
  ArrayType    m_NumberOfControlPoints{};
  ArrayType    m_CurrentNumberOfControlPoints{};
  ArrayType    m_CloseDimension{};
  ArrayType    m_SplineOrder{};
  ArrayType    m_NumberOfLevels{};
 
  typename WeightsContainerType::Pointer m_PointWeights{};
 
  typename PointDataImageType::Pointer m_PhiLattice{};
  typename PointDataImageType::Pointer m_PsiLattice{};
 
  vnl_matrix<RealType> m_RefinedLatticeCoefficients[ImageDimension]{};
 
  PointDataContainerPointer m_ResidualPointSetValues{};
 
  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{};
 
  std::vector<RealImagePointer>      m_OmegaLatticePerThread{};
  std::vector<PointDataImagePointer> m_DeltaLatticePerThread{};
 
  RealType m_BSplineEpsilon{ static_cast<RealType>(1e-3) };
  bool     m_IsFittingComplete{ false };
  bool     m_DoUpdateResidualValues{ false };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBSplineScatteredDataPointSetToImageFilter.hxx"
#endif
 
#endif