BinNormalisation.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    Copyright (C) 2014, 2021, 2024, University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

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

#include "stir/RegisteredObject.h"
#include "stir/Bin.h"
#include "stir/shared_ptr.h"
#include "stir/deprecated.h"

START_NAMESPACE_STIR

template <typename elemT>
class RelatedViewgrams;
class Succeeded;
class ProjDataInfo;
class ProjData;
class DataSymmetriesForViewSegmentNumbers;
class ExamInfo;
class BinNormalisation : public RegisteredObject<BinNormalisation>
{
public:
  BinNormalisation();

  ~BinNormalisation() override;
  void set_defaults() override;
  virtual float get_calibration_factor() const { return -1; }


  virtual inline bool is_trivial() const { return false; }


  virtual inline bool is_TOF_only_norm() const { return false; }


  virtual Succeeded set_up(const shared_ptr<const ExamInfo>& exam_info_sptr, const shared_ptr<const ProjDataInfo>&);


  virtual float get_bin_efficiency(const Bin& bin) const = 0;


  virtual void apply(RelatedViewgrams<float>&) const;


  virtual void undo(RelatedViewgrams<float>&) const;


  void apply(ProjData&,
             shared_ptr<DataSymmetriesForViewSegmentNumbers> = shared_ptr<DataSymmetriesForViewSegmentNumbers>()) const;


  void undo(ProjData&, shared_ptr<DataSymmetriesForViewSegmentNumbers> = shared_ptr<DataSymmetriesForViewSegmentNumbers>()) const;

  void set_exam_info_sptr(const shared_ptr<const ExamInfo> _exam_info_sptr);

  shared_ptr<const ExamInfo> get_exam_info_sptr() const;

protected:

  virtual void check(const ProjDataInfo& proj_data_info) const;

  virtual void check(const ExamInfo& exam_info) const;
  bool _already_set_up;
  shared_ptr<const ProjDataInfo> proj_data_info_sptr;

private:
  shared_ptr<const ExamInfo> exam_info_sptr;
};

END_NAMESPACE_STIR

#endif