rtkFourDSARTConeBeamReconstructionFilter.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 rtkFourDSARTConeBeamReconstructionFilter_h
#define rtkFourDSARTConeBeamReconstructionFilter_h

#include "rtkBackProjectionImageFilter.h"
#include "rtkForwardProjectionImageFilter.h"

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

#include "rtkRayBoxIntersectionImageFilter.h"
#include "rtkConstantImageSource.h"
#include "rtkIterativeConeBeamReconstructionFilter.h"
#include "rtkProjectionStackToFourDImageFilter.h"
#include "rtkFourDToProjectionStackImageFilter.h"
#include "rtkDisplacedDetectorImageFilter.h"

namespace rtk
{

template <class VolumeSeriesType, class ProjectionStackType>
class ITK_TEMPLATE_EXPORT FourDSARTConeBeamReconstructionFilter
  : public rtk::IterativeConeBeamReconstructionFilter<VolumeSeriesType, ProjectionStackType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FourDSARTConeBeamReconstructionFilter);

  using Self = FourDSARTConeBeamReconstructionFilter;
  using Superclass = IterativeConeBeamReconstructionFilter<VolumeSeriesType, ProjectionStackType>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  using InputImageType = VolumeSeriesType;
  using OutputImageType = VolumeSeriesType;
  using VolumeType = ProjectionStackType;

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

  using ExtractFilterType = itk::ExtractImageFilter<ProjectionStackType, ProjectionStackType>;
  using ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter<ProjectionStackType, ProjectionStackType>;
  using FourDToProjectionStackFilterType =
    rtk::FourDToProjectionStackImageFilter<ProjectionStackType, VolumeSeriesType>;
  using SubtractFilterType = itk::SubtractImageFilter<ProjectionStackType, ProjectionStackType>;
  using MultiplyFilterType = itk::MultiplyImageFilter<ProjectionStackType, ProjectionStackType, ProjectionStackType>;
  using AddFilterType = itk::AddImageFilter<VolumeSeriesType, VolumeSeriesType>;
  using BackProjectionFilterType = rtk::BackProjectionImageFilter<VolumeType, VolumeType>;
  using ProjectionStackToFourDFilterType =
    rtk::ProjectionStackToFourDImageFilter<VolumeSeriesType, ProjectionStackType>;
  using RayBoxIntersectionFilterType = rtk::RayBoxIntersectionImageFilter<ProjectionStackType, ProjectionStackType>;
  using DivideFilterType =
    itk::DivideOrZeroOutImageFilter<ProjectionStackType, ProjectionStackType, ProjectionStackType>;
  using DisplacedDetectorFilterType = rtk::DisplacedDetectorImageFilter<ProjectionStackType>;
  using ConstantVolumeSeriesSourceType = rtk::ConstantImageSource<VolumeSeriesType>;
  using ConstantProjectionStackSourceType = rtk::ConstantImageSource<ProjectionStackType>;
  using ThresholdFilterType = itk::ThresholdImageFilter<VolumeSeriesType>;

  itkNewMacro(Self);

#ifdef itkOverrideGetNameOfClassMacro
  itkOverrideGetNameOfClassMacro(FourDSARTConeBeamReconstructionFilter);
#else
  itkTypeMacro(FourDSARTConeBeamReconstructionFilter, IterativeConeBeamReconstructionFilter);
#endif


  void
  SetInputVolumeSeries(const VolumeSeriesType * VolumeSeries);
  typename VolumeSeriesType::ConstPointer
  GetInputVolumeSeries();

  void
  SetInputProjectionStack(const ProjectionStackType * Projection);
  typename ProjectionStackType::Pointer
  GetInputProjectionStack();

  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
  SetWeights(const itk::Array2D<float> _arg);

  virtual void
  SetSignal(const std::vector<double> signal);

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

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

  void
  VerifyPreconditions() ITKv5_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 FourDToProjectionStackFilterType::Pointer  m_FourDToProjectionStackFilter;
  typename SubtractFilterType::Pointer                m_SubtractFilter;
  typename AddFilterType::Pointer                     m_AddFilter;
  typename AddFilterType::Pointer                     m_AddFilter2;
  typename MultiplyFilterType::Pointer                m_MultiplyFilter;
  typename BackProjectionFilterType::Pointer          m_BackProjectionFilter;
  typename ProjectionStackToFourDFilterType::Pointer  m_ProjectionStackToFourDFilter;
  typename RayBoxIntersectionFilterType::Pointer      m_RayBoxFilter;
  typename DivideFilterType::Pointer                  m_DivideFilter;
  typename DisplacedDetectorFilterType::Pointer       m_DisplacedDetectorFilter;
  typename ConstantProjectionStackSourceType::Pointer m_ConstantProjectionStackSource;
  typename ConstantVolumeSeriesSourceType::Pointer    m_ConstantVolumeSeriesSource;
  typename ThresholdFilterType::Pointer               m_ThresholdFilter;

  std::vector<unsigned int> m_ProjectionsOrder;
  bool                      m_ProjectionsOrderInitialized;
  bool                      m_EnforcePositivity;
  std::vector<double>       m_Signal;
  bool                      m_DisableDisplacedDetectorFilter;

private:
  unsigned int m_NumberOfProjectionsPerSubset;

  ThreeDCircularProjectionGeometry::Pointer m_Geometry;

  unsigned int m_NumberOfIterations;

  double m_Lambda;
}; // end of class

} // end namespace rtk

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

#endif