BinNormalisationFromAttenuationImage.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2003- 2011, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_recon_buildblock_BinNormalisationFromAttenuationImage_H__
#define __stir_recon_buildblock_BinNormalisationFromAttenuationImage_H__

#include "stir/recon_buildblock/BinNormalisation.h"
#include "stir/RegisteredParsingObject.h"
#include "stir/DiscretisedDensity.h"
#include "stir/shared_ptr.h"
#include "stir/recon_buildblock/ForwardProjectorByBin.h"
#include <string>

START_NAMESPACE_STIR

class BinNormalisationFromAttenuationImage
    : public RegisteredParsingObject<BinNormalisationFromAttenuationImage, BinNormalisation>
{
private:
  using base_type = BinNormalisation;

public:
  static const char* const registered_name;


  BinNormalisationFromAttenuationImage();


  BinNormalisationFromAttenuationImage(const std::string& filename,
                                       shared_ptr<ForwardProjectorByBin> const& = shared_ptr<ForwardProjectorByBin>());


  BinNormalisationFromAttenuationImage(const shared_ptr<const DiscretisedDensity<3, float>>& attenuation_image_ptr,
                                       shared_ptr<ForwardProjectorByBin> const& = shared_ptr<ForwardProjectorByBin>());


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

  // import all apply/undo methods from base-class (we'll override some below)
  using base_type::apply;
  using base_type::undo;


  void apply(RelatedViewgrams<float>& viewgrams) const override;


  void undo(RelatedViewgrams<float>& viewgrams) const override;

  float get_bin_efficiency(const Bin& bin) const override;

private:
  shared_ptr<const DiscretisedDensity<3, float>> attenuation_image_ptr;
  shared_ptr<ForwardProjectorByBin> forward_projector_ptr;

  // parsing stuff
  void set_defaults() override;
  void initialise_keymap() override;
  bool post_processing() override;

  std::string attenuation_image_filename;
};

END_NAMESPACE_STIR

#endif