rtkMechlemOneStepSpectralReconstructionFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK Consortium
 *
 *  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 rtkMechlemOneStepSpectralReconstructionFilter_h
#define rtkMechlemOneStepSpectralReconstructionFilter_h

#include "rtkIterativeConeBeamReconstructionFilter.h"
#include "rtkThreeDCircularProjectionGeometry.h"
#include "rtkWeidingerForwardModelImageFilter.h"
#include "rtkGetNewtonUpdateImageFilter.h"
#include "rtkConstantImageSource.h"
#include "rtkNesterovUpdateImageFilter.h"
#include "rtkSeparableQuadraticSurrogateRegularizationImageFilter.h"
#include "rtkAddMatrixAndDiagonalImageFilter.h"
#include "rtkReorderProjectionsImageFilter.h"

#include <itkExtractImageFilter.h>
#include <itkAddImageFilter.h>
#include <itkMultiplyImageFilter.h>

#include <itkCastImageFilter.h>

#ifdef RTK_USE_CUDA
#  include "rtkCudaWeidingerForwardModelImageFilter.h"
#endif

namespace rtk
{
template <typename TOutputImage, typename TMeasuredProjections, typename TIncidentSpectrum>
class ITK_TEMPLATE_EXPORT MechlemOneStepSpectralReconstructionFilter
  : public rtk::IterativeConeBeamReconstructionFilter<TOutputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MechlemOneStepSpectralReconstructionFilter);

  using Self = MechlemOneStepSpectralReconstructionFilter;
  using Superclass = IterativeConeBeamReconstructionFilter<TOutputImage, TOutputImage>;
  using Pointer = itk::SmartPointer<Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MechlemOneStepSpectralReconstructionFilter);

  static constexpr unsigned int nBins = TMeasuredProjections::PixelType::Dimension;
  static constexpr unsigned int nMaterials = TOutputImage::PixelType::Dimension;
  using dataType = typename TOutputImage::PixelType::ValueType;

  using VectorImageType = typename itk::VectorImage<dataType, TOutputImage::ImageDimension>;

  using CPUOutputImageType = typename itk::Image<typename TOutputImage::PixelType, TOutputImage::ImageDimension>;
#ifdef RTK_USE_CUDA
  using HessiansImageType = typename std::conditional_t<
    std::is_same_v<TOutputImage, CPUOutputImageType>,
    itk::Image<itk::Vector<dataType, nMaterials * nMaterials>, TOutputImage::ImageDimension>,
    itk::CudaImage<itk::Vector<dataType, nMaterials * nMaterials>, TOutputImage::ImageDimension>>;
  using SingleComponentImageType = typename std::conditional_t<std::is_same_v<TOutputImage, CPUOutputImageType>,
                                                               itk::Image<dataType, TOutputImage::ImageDimension>,
                                                               itk::CudaImage<dataType, TOutputImage::ImageDimension>>;
#else
  using HessiansImageType =
    typename itk::Image<itk::Vector<dataType, nMaterials * nMaterials>, TOutputImage::ImageDimension>;
  using SingleComponentImageType = typename itk::Image<dataType, TOutputImage::ImageDimension>;
#endif

#if !defined(ITK_WRAPPING_PARSER)
#  ifdef RTK_USE_CUDA
  using WeidingerForwardModelType = typename std::conditional_t<
    std::is_same_v<TOutputImage, CPUOutputImageType>,
    WeidingerForwardModelImageFilter<TOutputImage, TMeasuredProjections, TIncidentSpectrum>,
    CudaWeidingerForwardModelImageFilter<TOutputImage, TMeasuredProjections, TIncidentSpectrum>>;
  using CudaSingleComponentForwardProjectionImageFilterType =
    typename std::conditional_t<std::is_same_v<TOutputImage, CPUOutputImageType>,
                                JosephForwardProjectionImageFilter<SingleComponentImageType, SingleComponentImageType>,
                                CudaForwardProjectionImageFilter<SingleComponentImageType, SingleComponentImageType>>;
  using CudaHessiansBackProjectionImageFilterType =
    typename std::conditional_t<std::is_same_v<TOutputImage, CPUOutputImageType>,
                                BackProjectionImageFilter<HessiansImageType, HessiansImageType>,
                                CudaBackProjectionImageFilter<HessiansImageType>>;
#  else
  using WeidingerForwardModelType =
    WeidingerForwardModelImageFilter<TOutputImage, TMeasuredProjections, TIncidentSpectrum>;
  using CudaSingleComponentForwardProjectionImageFilterType =
    JosephForwardProjectionImageFilter<SingleComponentImageType, SingleComponentImageType>;
  using CudaHessiansBackProjectionImageFilterType = BackProjectionImageFilter<HessiansImageType, HessiansImageType>;
#  endif
  using GradientsImageType = TOutputImage;
#endif

  using ForwardProjectionType = typename Superclass::ForwardProjectionType;
  using BackProjectionType = typename Superclass::BackProjectionType;

#if !defined(ITK_WRAPPING_PARSER)

  using CastMaterialVolumesFilterType = itk::CastImageFilter<VectorImageType, TOutputImage>;
  using CastMeasuredProjectionsFilterType = itk::CastImageFilter<VectorImageType, TMeasuredProjections>;
  using ExtractMeasuredProjectionsFilterType = itk::ExtractImageFilter<TMeasuredProjections, TMeasuredProjections>;
  using AddFilterType = itk::AddImageFilter<GradientsImageType>;
  using SingleComponentForwardProjectionFilterType =
    rtk::ForwardProjectionImageFilter<SingleComponentImageType, SingleComponentImageType>;
  using ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter<TOutputImage, TOutputImage>;
  using GradientsBackProjectionFilterType = rtk::BackProjectionImageFilter<GradientsImageType, GradientsImageType>;
  using HessiansBackProjectionFilterType = rtk::BackProjectionImageFilter<HessiansImageType, HessiansImageType>;
  using NesterovFilterType = rtk::NesterovUpdateImageFilter<TOutputImage>;
  using SingleComponentImageSourceType = rtk::ConstantImageSource<SingleComponentImageType>;
  using MaterialProjectionsSourceType = rtk::ConstantImageSource<TOutputImage>;
  using GradientsSourceType = rtk::ConstantImageSource<GradientsImageType>;
  using HessiansSourceType = rtk::ConstantImageSource<HessiansImageType>;
  using SQSRegularizationType = rtk::SeparableQuadraticSurrogateRegularizationImageFilter<GradientsImageType>;
  using AddMatrixAndDiagonalFilterType = rtk::AddMatrixAndDiagonalImageFilter<GradientsImageType, HessiansImageType>;
  using NewtonFilterType = rtk::GetNewtonUpdateImageFilter<GradientsImageType, HessiansImageType>;
  using MultiplyFilterType = itk::MultiplyImageFilter<TOutputImage, SingleComponentImageType>;
  using MultiplyGradientFilterType = itk::MultiplyImageFilter<GradientsImageType, SingleComponentImageType>;
  using ReorderMeasuredProjectionsFilterType = rtk::ReorderProjectionsImageFilter<TMeasuredProjections>;
  using ReorderProjectionsWeightsFilterType = rtk::ReorderProjectionsImageFilter<SingleComponentImageType>;
#endif

  itkSetConstObjectMacro(Geometry, ThreeDCircularProjectionGeometry);

  itkSetMacro(NumberOfIterations, int);
  itkGetMacro(NumberOfIterations, int);

  itkSetMacro(NumberOfSubsets, int);
  itkGetMacro(NumberOfSubsets, int);

  itkSetMacro(ResetNesterovEvery, int);
  itkGetMacro(ResetNesterovEvery, int);

  void
  SetInputMaterialVolumes(const TOutputImage * materialVolumes);
  void
  SetInputMaterialVolumes(const VectorImageType * materialVolumes);
  void
  SetInputMeasuredProjections(const TMeasuredProjections * measuredProjections);
  void
  SetInputMeasuredProjections(const VectorImageType * measuredProjections);
  void
  SetInputIncidentSpectrum(const TIncidentSpectrum * incidentSpectrum);
#ifndef ITK_FUTURE_LEGACY_REMOVE
  void
  SetInputPhotonCounts(const TMeasuredProjections * measuredProjections);
  void
  SetInputSpectrum(const TIncidentSpectrum * incidentSpectrum);
#endif
  void
  SetSupportMask(const SingleComponentImageType * support);
  void
  SetSpatialRegularizationWeights(const SingleComponentImageType * regweights);
  void
  SetProjectionWeights(const SingleComponentImageType * weiprojections);

  itkSetMacro(RegularizationWeights, typename TOutputImage::PixelType);
  itkGetMacro(RegularizationWeights, typename TOutputImage::PixelType);

  itkSetMacro(RegularizationRadius, typename TOutputImage::RegionType::SizeType);
  itkGetMacro(RegularizationRadius, typename TOutputImage::RegionType::SizeType);

  using BinnedDetectorResponseType = vnl_matrix<dataType>;
  using MaterialAttenuationsType = vnl_matrix<dataType>;
  virtual void
  SetBinnedDetectorResponse(const BinnedDetectorResponseType & detResp);
  virtual void
  SetMaterialAttenuations(const MaterialAttenuationsType & matAtt);

protected:
  MechlemOneStepSpectralReconstructionFilter();
  ~MechlemOneStepSpectralReconstructionFilter() override = default;

  void
  VerifyPreconditions() const override;

  void
  GenerateData() override;

#if !defined(ITK_WRAPPING_PARSER)

  typename CastMaterialVolumesFilterType::Pointer              m_CastMaterialVolumesFilter;
  typename CastMeasuredProjectionsFilterType::Pointer          m_CastMeasuredProjectionsFilter;
  typename ExtractMeasuredProjectionsFilterType::Pointer       m_ExtractMeasuredProjectionsFilter;
  typename AddFilterType::Pointer                              m_AddGradients;
  typename SingleComponentForwardProjectionFilterType::Pointer m_SingleComponentForwardProjectionFilter;
  typename MaterialProjectionsSourceType::Pointer              m_ProjectionsSource;
  typename SingleComponentImageSourceType::Pointer             m_SingleComponentProjectionsSource;
  typename SingleComponentImageSourceType::Pointer             m_SingleComponentVolumeSource;
  typename GradientsSourceType::Pointer                        m_GradientsSource;
  typename HessiansSourceType::Pointer                         m_HessiansSource;
  typename WeidingerForwardModelType::Pointer                  m_WeidingerForward;
  typename SQSRegularizationType::Pointer                      m_SQSRegul;
  typename AddMatrixAndDiagonalFilterType::Pointer             m_AddHessians;
  typename NewtonFilterType::Pointer                           m_NewtonFilter;
  typename NesterovFilterType::Pointer                         m_NesterovFilter;
  typename ForwardProjectionFilterType::Pointer                m_ForwardProjectionFilter;
  typename GradientsBackProjectionFilterType::Pointer          m_GradientsBackProjectionFilter;
  typename HessiansBackProjectionFilterType::Pointer           m_HessiansBackProjectionFilter;
  typename MultiplyFilterType::Pointer                         m_MultiplySupportFilter;
  typename MultiplyGradientFilterType::Pointer                 m_MultiplyRegulGradientsFilter;
  typename MultiplyGradientFilterType::Pointer                 m_MultiplyRegulHessiansFilter;
  typename MultiplyGradientFilterType::Pointer                 m_MultiplyGradientToBeBackprojectedFilter;
  typename ReorderMeasuredProjectionsFilterType::Pointer       m_ReorderMeasuredProjectionsFilter;
  typename ReorderProjectionsWeightsFilterType::Pointer        m_ReorderProjectionsWeightsFilter;
#endif

  void
  VerifyInputInformation() const override
  {}

  void
  GenerateInputRequestedRegion() override;
  void
  GenerateOutputInformation() override;

  typename TOutputImage::ConstPointer
  GetInputMaterialVolumes();
  typename TMeasuredProjections::ConstPointer
  GetInputMeasuredProjections();
  typename TIncidentSpectrum::ConstPointer
  GetInputIncidentSpectrum();
#ifndef ITK_FUTURE_LEGACY_REMOVE
  typename TMeasuredProjections::ConstPointer
  GetInputPhotonCounts();
  typename TIncidentSpectrum::ConstPointer
  GetInputSpectrum();
#endif
  typename SingleComponentImageType::ConstPointer
  GetSupportMask();
  typename SingleComponentImageType::ConstPointer
  GetSpatialRegularizationWeights();
  typename SingleComponentImageType::ConstPointer
  GetProjectionWeights();

#if !defined(ITK_WRAPPING_PARSER)

  typename SingleComponentForwardProjectionFilterType::Pointer
  InstantiateSingleComponentForwardProjectionFilter(int fwtype);
  typename HessiansBackProjectionFilterType::Pointer
  InstantiateHessiansBackProjectionFilter(int bptype);
#endif


  ThreeDCircularProjectionGeometry::ConstPointer m_Geometry;

  int              m_NumberOfIterations;
  int              m_NumberOfProjectionsPerSubset;
  int              m_NumberOfSubsets;
  std::vector<int> m_NumberOfProjectionsInSubset;
  int              m_NumberOfProjections;
  int              m_ResetNesterovEvery;

  typename TOutputImage::PixelType            m_RegularizationWeights;
  typename TOutputImage::RegionType::SizeType m_RegularizationRadius;
};
} // namespace rtk


#ifndef ITK_MANUAL_INSTANTIATION
#  include "rtkMechlemOneStepSpectralReconstructionFilter.hxx"
#endif

#endif