FBP3DRPReconstruction.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2007, Hammersmith Imanet Ltd

    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_analytic_FBP3DRP_FBP3DRPRECONSTRUCTION_H__
#define __stir_analytic_FBP3DRP_FBP3DRPRECONSTRUCTION_H__

#include "stir/recon_buildblock/AnalyticReconstruction.h"
#include "stir/ProjDataInfoCylindrical.h"
#include "stir/recon_buildblock/ForwardProjectorByBin.h"
#include "stir/recon_buildblock/BackProjectorByBin.h"
#include "stir/analytic/FBP3DRP/ColsherFilter.h"
#include "stir/ArcCorrection.h"
#include "stir/shared_ptr.h"
#include "stir/RegisteredParsingObject.h"

START_NAMESPACE_STIR

template <typename elemT>
class RelatedViewgrams;
template <typename elemT>
class Sinogram;
template <typename elemT>
class SegmentBySinogram;
template <typename elemT>
class VoxelsOnCartesianGrid;
template <int num_dimensions, typename elemT>
class DiscretisedDensity;
class Succeeded;

/* KT 180899 forget about PETAnalyticReconstruction for the moment
 TODO Derive from PETAnalyticReconstruction when it makes any sense
 */
class FBP3DRPReconstruction
    : public RegisteredParsingObject<FBP3DRPReconstruction, Reconstruction<DiscretisedDensity<3, float>>, AnalyticReconstruction>
{
  // typedef AnalyticReconstruction base_type;
  typedef RegisteredParsingObject<FBP3DRPReconstruction, Reconstruction<DiscretisedDensity<3, float>>, AnalyticReconstruction>
      base_type;

public:
  static const char* const registered_name;

  FBP3DRPReconstruction();

  explicit FBP3DRPReconstruction(const std::string& parameter_filename);

  // explicitly implement destructor (NOT inline) to avoid funny problems with
  // the shared_ptr<DiscretisedDensity<3,float> > destructor with gcc.
  // Otherwise, gcc will complain if you didn't include DiscretisedDensity.h
  // because it doesn't know ~DiscretisedDensity.
  ~FBP3DRPReconstruction() override;

  std::string method_info() const override;

  Succeeded set_up(shared_ptr<DiscretisedDensity<3, float>> const& target_image_sptr) override;

protected:
  Succeeded actual_reconstruct(shared_ptr<DiscretisedDensity<3, float>> const&) override;

  void do_best_fit(const Sinogram<float>& sino_measured, const Sinogram<float>& sino_calculated);

  void do_2D_reconstruction();

  void do_save_img(const char* file, const VoxelsOnCartesianGrid<float>& data) const;

  void do_read_image2D();

  void do_3D_Reconstruction(VoxelsOnCartesianGrid<float>& image);

  void do_arc_correction(RelatedViewgrams<float>& viewgrams) const;

  void do_grow3D_viewgram(RelatedViewgrams<float>& viewgrams, int rmin, int rmax);
  void
  do_forward_project_view(RelatedViewgrams<float>& viewgrams, int rmin, int rmax, int orig_min_ring, int orig_max_ring) const;
  void do_colsher_filter_view(RelatedViewgrams<float>& viewgrams);
  void do_3D_backprojection_view(RelatedViewgrams<float> const& viewgrams, int rmin, int rmax);
  void do_log_file(const VoxelsOnCartesianGrid<float>& image);

  virtual void do_byview_initialise(const VoxelsOnCartesianGrid<float>& image) const {};

  virtual void do_byview_finalise(VoxelsOnCartesianGrid<float>& image){};

public:
  // KT 230899 this has to be public to let the Para stuff access it (sadly)

  virtual void do_process_viewgrams(RelatedViewgrams<float>& viewgrams, int rmin, int rmax, int orig_min_ring, int orig_max_ring);

  // parameters stuff
public:
  void ask_parameters();

protected:
  int display_level;

  int save_intermediate_files;


  std::string image_for_reprojection_filename;


  int num_segments_to_combine;

  int PadS;
  int PadZ;
  double alpha_ramp;
  double fc_ramp;

  double alpha_colsher_axial;
  double fc_colsher_axial;
  double alpha_colsher_planar;
  double fc_colsher_planar;
  int colsher_stretch_factor_axial;
  int colsher_stretch_factor_planar;

  int fit_projections;

private:
  void set_defaults() override;
  void initialise_keymap() override;

  const ProjDataInfoCylindrical& input_proj_data_info_cyl() const;
  shared_ptr<ProjDataInfo> proj_data_info_with_missing_data_sptr;

  shared_ptr<DiscretisedDensity<3, float>> image_estimate_density_ptr;
  // convenience access functions to the above member
  inline VoxelsOnCartesianGrid<float>& estimated_image();
  inline const VoxelsOnCartesianGrid<float>& estimated_image() const;

  shared_ptr<ForwardProjectorByBin> forward_projector_sptr;
  shared_ptr<BackProjectorByBin> back_projector_sptr;
#ifndef NRFFT
  ColsherFilter colsher_filter;
#endif
  float alpha_fit;
  float beta_fit;

  shared_ptr<ArcCorrection> arc_correction_sptr;
};

END_NAMESPACE_STIR

#endif