rtkOSEMConeBeamReconstructionFilter.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 rtkOSEMConeBeamReconstructionFilter_h
#define rtkOSEMConeBeamReconstructionFilter_h

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

#include <itkExtractImageFilter.h>
#include <itkMultiplyImageFilter.h>
#include <itkAddImageAdaptor.h>
#include <itkDivideImageFilter.h>
#include <itkDivideOrZeroOutImageFilter.h>

#include "rtkConstantImageSource.h"
#include "rtkIterativeConeBeamReconstructionFilter.h"

namespace rtk
{

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

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

  using VolumeType = TVolumeImage;
  using ProjectionType = TProjectionImage;

  using ExtractFilterType = itk::ExtractImageFilter<ProjectionType, ProjectionType>;
  using MultiplyFilterType = itk::MultiplyImageFilter<VolumeType, VolumeType, VolumeType>;
  using ForwardProjectionFilterType = rtk::ForwardProjectionImageFilter<ProjectionType, VolumeType>;
  using BackProjectionFilterType = rtk::BackProjectionImageFilter<VolumeType, 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 DePierroRegularizationFilterType = rtk::DePierroRegularizationImageFilter<VolumeType, VolumeType>;

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

  itkNewMacro(Self);

  itkTypeMacro(OSEMConeBeamReconstructionFilter, IterativeConeBeamReconstructionFilter);

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

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

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

  itkGetMacro(SigmaZero, double);
  itkSetMacro(SigmaZero, double);

  itkGetMacro(Alpha, double);
  itkSetMacro(Alpha, double);

  itkGetMacro(BetaRegularization, double);
  itkSetMacro(BetaRegularization, double);

  itkGetMacro(StoreNormalizationImages, bool);
  itkSetMacro(StoreNormalizationImages, bool);

protected:
  OSEMConeBeamReconstructionFilter();
  ~OSEMConeBeamReconstructionFilter() 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 ForwardProjectionFilterType::Pointer      m_ForwardProjectionFilter;
  typename MultiplyFilterType::Pointer               m_MultiplyFilter;
  typename BackProjectionFilterType::Pointer         m_BackProjectionFilter;
  typename BackProjectionFilterType::Pointer         m_BackProjectionNormalizationFilter;
  typename DivideProjectionFilterType::Pointer       m_DivideProjectionFilter;
  typename DivideVolumeFilterType::Pointer           m_DivideVolumeFilter;
  typename ConstantProjectionSourceType::Pointer     m_ZeroConstantProjectionStackSource;
  typename ConstantProjectionSourceType::Pointer     m_OneConstantProjectionStackSource;
  typename ConstantVolumeSourceType::Pointer         m_ConstantVolumeSource;
  typename DePierroRegularizationFilterType::Pointer m_DePierroRegularizationFilter;

private:
  unsigned int m_NumberOfProjectionsPerSubset{ 1 };

  ThreeDCircularProjectionGeometry::Pointer m_Geometry;

  unsigned int m_NumberOfIterations{ 3 };

  double m_SigmaZero{ -1. };
  double m_Alpha{ -1. };

  double m_BetaRegularization{ 0. };

  bool m_StoreNormalizationImages{ true };

}; // end of class

} // end namespace rtk

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

#endif