ForwardProjectorByBin.h

Go to the documentation of this file.

//
//

#ifndef __stir_recon_buildblock_ForwardProjectorByBin_h__
#define __stir_recon_buildblock_ForwardProjectorByBin_h__

/*
    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
*/

#include "stir/RegisteredObject.h"
#include "stir/TimedObject.h"
#include "stir/VoxelsOnCartesianGrid.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 ForwardProjectorByBin : public TimedObject, public RegisteredObject<ForwardProjectorByBin>
{
public:
  // inline
  ForwardProjectorByBin();


  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 forward_project(ProjData&, const DiscretisedDensity<3, float>&, int subset_num = 0, int num_subsets = 1, bool zero = true);
#ifdef STIR_PROJECTORS_AS_V3

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

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

  void forward_project(RelatedViewgrams<float>&,
                       const DiscretisedDensity<3, 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 forward_project(ProjData&, int subset_num = 0, int num_subsets = 1, bool zero = true);


  void forward_project(RelatedViewgrams<float>&);

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

  void forward_project(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);

#if 0 // disabled as currently not used. needs to be written in the new style anyway

    void forward_project(Bin&,
                         const DiscretisedDensity<3,float>&);
#endif
  ~ForwardProjectorByBin() override;

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

  void set_pre_data_processor(shared_ptr<DataProcessor<DiscretisedDensity<3, float>>> pre_data_processor_sptr);

protected:
  virtual void actual_forward_project(RelatedViewgrams<float>&,
                                      const DiscretisedDensity<3, 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_forward_project(RelatedViewgrams<float>& viewgrams,
                                      const int min_axial_pos_num,
                                      const int max_axial_pos_num,
                                      const int min_tangential_pos_num,
                                      const int max_tangential_pos_num);

#if 0 // disabled as currently not used. needs to be written in the new style anyway
    virtual void actual_forward_project(Bin&,
                                        const DiscretisedDensity<3,float>&) = 0;
#endif


  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>>> _pre_data_processor_sptr;

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

protected:
  shared_ptr<const ProjDataInfo> _proj_data_info_sptr;
};

END_NAMESPACE_STIR

#endif // __stir_recon_buildblock_ForwardProjectorByBin_h__