rtkSARTConeBeamReconstructionFilter.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 rtkSARTConeBeamReconstructionFilter_h
#define rtkSARTConeBeamReconstructionFilter_h

#include "rtkBackProjectionImageFilter.h"
#include "rtkForwardProjectionImageFilter.h"
#include "rtkRayBoxIntersectionImageFilter.h"
#include "rtkConstantImageSource.h"
#include "rtkIterativeConeBeamReconstructionFilter.h"
#include "rtkDisplacedDetectorImageFilter.h"
#include "rtkNesterovUpdateImageFilter.h"

#include <itkExtractImageFilter.h>
#include <itkMultiplyImageFilter.h>
#include <itkSubtractImageFilter.h>
#include <itkAddImageAdaptor.h>
#include <itkAddImageFilter.h>
#include <itkDivideOrZeroOutImageFilter.h>
#include <itkThresholdImageFilter.h>

namespace rtk
{

template <class TVolumeImage, class TProjectionImage = TVolumeImage>
class ITK_TEMPLATE_EXPORT SARTConeBeamReconstructionFilter
  : public rtk::IterativeConeBeamReconstructionFilter<TVolumeImage, TProjectionImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SARTConeBeamReconstructionFilter);

  using Self = SARTConeBeamReconstructionFilter;
  using Superclass = IterativeConeBeamReconstructionFilter<TVolumeImage, TProjectionImage>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  using VolumeType = TVolumeImage;
  using ProjectionType = TProjectionImage;
  using ProjectionPixelType = typename ProjectionType::PixelType;

  using ExtractFilterType = itk::ExtractImageFilter<ProjectionType, ProjectionType>;
  using MultiplyFilterType = itk::MultiplyImageFilter<ProjectionType, ProjectionType, ProjectionType>;
  using ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter<ProjectionType, VolumeType>;
  using SubtractFilterType = itk::SubtractImageFilter<ProjectionType, ProjectionType>;
  using AddFilterType = itk::AddImageFilter<VolumeType, VolumeType>;
  using NesterovFilterType = rtk::NesterovUpdateImageFilter<VolumeType>;
  using BackProjectionFilterType = rtk::BackProjectionImageFilter<VolumeType, ProjectionType>;
  using RayBoxIntersectionFilterType = rtk::RayBoxIntersectionImageFilter<ProjectionType, ProjectionType>;
  using DivideProjectionFilterType = itk::DivideOrZeroOutImageFilter<ProjectionType, ProjectionType, ProjectionType>;
  using DivideVolumeFilterType = itk::DivideOrZeroOutImageFilter<VolumeType, VolumeType, VolumeType>;
  using ConstantVolumeSourceType = rtk::ConstantImageSource<VolumeType>;
  using ConstantProjectionSourceType = rtk::ConstantImageSource<ProjectionType>;
  using ThresholdFilterType = itk::ThresholdImageFilter<VolumeType>;
  using DisplacedDetectorFilterType = rtk::DisplacedDetectorImageFilter<ProjectionType>;
  using GatingWeightsFilterType = itk::MultiplyImageFilter<ProjectionType, ProjectionType, ProjectionType>;

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SARTConeBeamReconstructionFilter);

  itkGetModifiableObjectMacro(Geometry, ThreeDCircularProjectionGeometry);
  itkSetObjectMacro(Geometry, ThreeDCircularProjectionGeometry);

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

  itkGetMacro(NumberOfProjectionsPerSubset, unsigned int);
  itkSetMacro(NumberOfProjectionsPerSubset, unsigned int);

  itkGetMacro(Lambda, double);
  itkSetMacro(Lambda, double);

  itkGetMacro(EnforcePositivity, bool);
  itkSetMacro(EnforcePositivity, bool);

  void
  SetGatingWeights(std::vector<float> weights);

  itkSetMacro(DisableDisplacedDetectorFilter, bool);
  itkGetMacro(DisableDisplacedDetectorFilter, bool);

  itkSetMacro(DivisionThreshold, ProjectionPixelType);
  itkGetMacro(DivisionThreshold, ProjectionPixelType);

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

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

  void
  VerifyPreconditions() const override;

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateOutputInformation() override;

  void
  GenerateData() override;

  void
  VerifyInputInformation() const override
  {}

  typename ExtractFilterType::Pointer            m_ExtractFilter;
  typename ExtractFilterType::Pointer            m_ExtractFilterRayBox;
  typename MultiplyFilterType::Pointer           m_ZeroMultiplyFilter;
  typename ForwardProjectionFilterType::Pointer  m_ForwardProjectionFilter;
  typename SubtractFilterType::Pointer           m_SubtractFilter;
  typename AddFilterType::Pointer                m_AddFilter;
  typename MultiplyFilterType::Pointer           m_MultiplyFilter;
  typename BackProjectionFilterType::Pointer     m_BackProjectionFilter;
  typename BackProjectionFilterType::Pointer     m_BackProjectionNormalizationFilter;
  typename RayBoxIntersectionFilterType::Pointer m_RayBoxFilter;
  typename DivideProjectionFilterType::Pointer   m_DivideProjectionFilter;
  typename DivideVolumeFilterType::Pointer       m_DivideVolumeFilter;
  typename ConstantProjectionSourceType::Pointer m_ConstantProjectionStackSource;
  typename ConstantProjectionSourceType::Pointer m_OneConstantProjectionStackSource;
  typename ConstantVolumeSourceType::Pointer     m_ConstantVolumeSource;
  typename ThresholdFilterType::Pointer          m_ThresholdFilter;
  typename DisplacedDetectorFilterType::Pointer  m_DisplacedDetectorFilter;
  typename GatingWeightsFilterType::Pointer      m_GatingWeightsFilter;
  typename NesterovFilterType::Pointer           m_NesterovFilter;

  ProjectionPixelType m_DivisionThreshold;

  bool m_EnforcePositivity;
  bool m_DisableDisplacedDetectorFilter{};

private:
  unsigned int m_NumberOfProjectionsPerSubset{ 1 };

  ThreeDCircularProjectionGeometry::Pointer m_Geometry;

  unsigned int m_NumberOfIterations;

  double m_Lambda;

  bool               m_IsGated{};
  std::vector<float> m_GatingWeights;

  int m_ResetNesterovEvery{ 1 };
}; // end of class

} // end namespace rtk

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

#endif