rtkADMMTotalVariationConeBeamReconstructionFilter.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 rtkADMMTotalVariationConeBeamReconstructionFilter_h
#define rtkADMMTotalVariationConeBeamReconstructionFilter_h

#include <itkImageToImageFilter.h>
#include <itkAddImageFilter.h>
#include <itkSubtractImageFilter.h>
#include <itkMultiplyImageFilter.h>

#include "rtkConjugateGradientImageFilter.h"
#include "rtkSoftThresholdTVImageFilter.h"
#include "rtkADMMTotalVariationConjugateGradientOperator.h"
#include "rtkIterativeConeBeamReconstructionFilter.h"
#include "rtkThreeDCircularProjectionGeometry.h"
#include "rtkDisplacedDetectorImageFilter.h"
#include "rtkMultiplyByVectorImageFilter.h"

namespace rtk
{
template <typename TOutputImage,
          typename TGradientOutputImage =
            itk::Image<itk::CovariantVector<typename TOutputImage::ValueType, TOutputImage::ImageDimension>,
                       TOutputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT ADMMTotalVariationConeBeamReconstructionFilter
  : public rtk::IterativeConeBeamReconstructionFilter<TOutputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ADMMTotalVariationConeBeamReconstructionFilter);

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

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

  itkNewMacro(Self);

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


  using ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter<TOutputImage, TOutputImage>;
  using ForwardProjectionFilterPointer = typename ForwardProjectionFilterType::Pointer;
  using BackProjectionFilterType = rtk::BackProjectionImageFilter<TOutputImage, TOutputImage>;
  using BackProjectionFilterPointer = typename BackProjectionFilterType::Pointer;
  using ConjugateGradientFilterType = rtk::ConjugateGradientImageFilter<TOutputImage>;
  using ImageGradientFilterType = ForwardDifferenceGradientImageFilter<TOutputImage,
                                                                       typename TOutputImage::ValueType,
                                                                       typename TOutputImage::ValueType,
                                                                       TGradientOutputImage>;
  using ImageDivergenceFilterType = rtk::BackwardDifferenceDivergenceImageFilter<TGradientOutputImage, TOutputImage>;
  typedef rtk::SoftThresholdTVImageFilter<TGradientOutputImage> SoftThresholdTVFilterType;
  using SubtractVolumeFilterType = itk::SubtractImageFilter<TOutputImage>;
  using AddGradientsFilterType = itk::AddImageFilter<TGradientOutputImage>;
  using MultiplyVolumeFilterType = itk::MultiplyImageFilter<TOutputImage>;
  using MultiplyGradientFilterType = itk::MultiplyImageFilter<TGradientOutputImage>;
  using SubtractGradientsFilterType = itk::SubtractImageFilter<TGradientOutputImage>;
  using CGOperatorFilterType = rtk::ADMMTotalVariationConjugateGradientOperator<TOutputImage>;
  using DisplacedDetectorFilterType = rtk::DisplacedDetectorImageFilter<TOutputImage>;
  using GatingWeightsFilterType = rtk::MultiplyByVectorImageFilter<TOutputImage>;

  itkSetObjectMacro(Geometry, ThreeDCircularProjectionGeometry);

  void
  SetBetaForCurrentIteration(int iter);

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

  itkSetMacro(Alpha, float);
  itkGetMacro(Alpha, float);

  itkSetMacro(Beta, float);
  itkGetMacro(Beta, float);

  itkSetMacro(AL_iterations, float);
  itkGetMacro(AL_iterations, float);

  itkSetMacro(CG_iterations, float);
  itkGetMacro(CG_iterations, float);

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

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

  void
  VerifyPreconditions() const override;

  void
  GenerateData() override;

  typename SubtractGradientsFilterType::Pointer                              m_SubtractFilter1;
  typename SubtractGradientsFilterType::Pointer                              m_SubtractFilter2;
  typename MultiplyVolumeFilterType::Pointer                                 m_MultiplyFilter;
  typename MultiplyVolumeFilterType::Pointer                                 m_ZeroMultiplyVolumeFilter;
  typename MultiplyGradientFilterType::Pointer                               m_ZeroMultiplyGradientFilter;
  typename ImageGradientFilterType::Pointer                                  m_GradientFilter1;
  typename ImageGradientFilterType::Pointer                                  m_GradientFilter2;
  typename SubtractVolumeFilterType::Pointer                                 m_SubtractVolumeFilter;
  typename AddGradientsFilterType::Pointer                                   m_AddGradientsFilter;
  typename ImageDivergenceFilterType::Pointer                                m_DivergenceFilter;
  typename ConjugateGradientFilterType::Pointer                              m_ConjugateGradientFilter;
  typename SoftThresholdTVFilterType::Pointer                                m_SoftThresholdFilter;
  typename CGOperatorFilterType::Pointer                                     m_CGOperator;
  typename ForwardProjectionImageFilter<TOutputImage, TOutputImage>::Pointer m_ForwardProjectionFilter;
  typename BackProjectionImageFilter<TOutputImage, TOutputImage>::Pointer    m_BackProjectionFilterForConjugateGradient;
  typename BackProjectionImageFilter<TOutputImage, TOutputImage>::Pointer    m_BackProjectionFilter;
  typename DisplacedDetectorFilterType::Pointer                              m_DisplacedDetectorFilter;
  typename GatingWeightsFilterType::Pointer                                  m_GatingWeightsFilter;

  void
  VerifyInputInformation() const override
  {}

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

  bool               m_IsGated;
  std::vector<float> m_GatingWeights;
  bool               m_DisableDisplacedDetectorFilter;

private:
  float        m_Alpha;
  float        m_Beta;
  unsigned int m_AL_iterations;
  unsigned int m_CG_iterations;

  ThreeDCircularProjectionGeometry::Pointer m_Geometry;
};
} // namespace rtk


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

#endif