BackProjectorByBin.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    Copyright (C) 2018-2019, University College London
    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_recon_buildblock_BackProjectorByBin_h_
#define __stir_recon_buildblock_BackProjectorByBin_h_

#include "stir/RegisteredObject.h"
#include "stir/TimedObject.h"
#include "stir/shared_ptr.h"
#include "stir/Bin.h"
#include "stir/recon_buildblock/ProjMatrixElemsForOneBin.h"

START_NAMESPACE_STIR

template <typename elemT>
class RelatedViewgrams;
template <int num_dimensions, class elemT>
class DiscretisedDensity;
class ProjDataInfo;
class ProjData;
class DataSymmetriesForViewSegmentNumbers;
template <typename DataT>
class DataProcessor;

class BackProjectorByBin : public TimedObject, public RegisteredObject<BackProjectorByBin>
{
public:
  BackProjectorByBin();

  ~BackProjectorByBin() override;


  virtual void set_up(const shared_ptr<const ProjDataInfo>& proj_data_info_ptr,
                      const shared_ptr<const DiscretisedDensity<3, float>>& density_info_sptr // TODO should be Info only
                      )
      = 0;

  virtual const DataSymmetriesForViewSegmentNumbers* get_symmetries_used() const = 0;


  void back_project(DiscretisedDensity<3, float>&, const ProjData&, int subset_num = 0, int num_subsets = 1);
#ifdef STIR_PROJECTORS_AS_V3

  void back_project(DiscretisedDensity<3, float>&, const RelatedViewgrams<float>&);

  void back_project(DiscretisedDensity<3, float>&,
                    const RelatedViewgrams<float>&,
                    const int min_axial_pos_num,
                    const int max_axial_pos_num);

  void back_project(DiscretisedDensity<3, float>&,
                    const RelatedViewgrams<float>&,
                    const int min_axial_pos_num,
                    const int max_axial_pos_num,
                    const int min_tangential_pos_num,
                    const int max_tangential_pos_num);
#endif

  virtual void back_project(const ProjData&, int subset_num = 0, int num_subsets = 1);

  void back_project(const RelatedViewgrams<float>&);

  void back_project(const RelatedViewgrams<float>&, const int min_axial_pos_num, const int max_axial_pos_num);

  void back_project(const RelatedViewgrams<float>&,
                    const int min_axial_pos_num,
                    const int max_axial_pos_num,
                    const int min_tangential_pos_num,
                    const int max_tangential_pos_num);

  virtual void start_accumulating_in_new_target();

  virtual void get_output(DiscretisedDensity<3, float>&) const;

  void set_post_data_processor(shared_ptr<DataProcessor<DiscretisedDensity<3, float>>> post_data_processor_sptr);

  virtual BackProjectorByBin* clone() const = 0;

protected:
  virtual void actual_back_project(DiscretisedDensity<3, float>&,
                                   const RelatedViewgrams<float>&,
                                   const int min_axial_pos_num,
                                   const int max_axial_pos_num,
                                   const int min_tangential_pos_num,
                                   const int max_tangential_pos_num);

  virtual void actual_back_project(const RelatedViewgrams<float>&,
                                   const int min_axial_pos_num,
                                   const int max_axial_pos_num,
                                   const int min_tangential_pos_num,
                                   const int max_tangential_pos_num);

  virtual void check(const ProjDataInfo& proj_data_info) const;


  virtual void check(const ProjDataInfo& proj_data_info, const DiscretisedDensity<3, float>& density_info) const;

  bool _already_set_up;

  shared_ptr<DiscretisedDensity<3, float>> _density_sptr;
  shared_ptr<DataProcessor<DiscretisedDensity<3, float>>> _post_data_processor_sptr;

  void set_defaults() override;
  void initialise_keymap() override;

protected:
  shared_ptr<const ProjDataInfo> _proj_data_info_sptr;

private:
#ifdef STIR_OPENMP
  std::vector<shared_ptr<DiscretisedDensity<3, float>>> _local_output_image_sptrs;
#endif
};

END_NAMESPACE_STIR

#endif // __BackProjectorByBin_h_