PoissonLogLikelihoodWithLinearModelForMeanAndListModeData.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2003- 2007, Hammersmith Imanet Ltd
    Copyright (C) 2018, 2022 University College London
    Copyright (C) 2021, University of Pennsylvania
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

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

//#include "stir/RegisteredParsingObject.h"
#include "stir/recon_buildblock/PoissonLogLikelihoodWithLinearModelForMean.h"
#include "stir/listmode/ListModeData.h"
#include "stir/ParseAndCreateFrom.h"
#include "stir/TimeFrameDefinitions.h"

START_NAMESPACE_STIR

template <typename TargetT>
class PoissonLogLikelihoodWithLinearModelForMeanAndListModeData : public PoissonLogLikelihoodWithLinearModelForMean<TargetT>
{
private:
  typedef PoissonLogLikelihoodWithLinearModelForMean<TargetT> base_type;

public:
  PoissonLogLikelihoodWithLinearModelForMeanAndListModeData();

  // virtual TargetT * construct_target_ptr();

  Succeeded set_up_before_sensitivity(shared_ptr<const TargetT> const& target_sptr) override;


  TimeFrameDefinitions frame_defs;

  void set_normalisation_sptr(const shared_ptr<BinNormalisation>&) override;
  void set_additive_proj_data_sptr(const shared_ptr<ExamData>&) override;

  void set_input_data(const shared_ptr<ExamData>&) override;
  const ListModeData& get_input_data() const override;

  void set_max_segment_num_to_process(int);

  int get_max_segment_num_to_process() const;


  virtual void set_cache_path(const std::string& cache_path);
  virtual std::string get_cache_path() const;


  virtual std::string get_cache_filename(unsigned int icache) const;


  void set_recompute_cache(bool);
  bool get_recompute_cache() const;


  void set_skip_lm_input_file(const bool arg);


  virtual void set_cache_max_size(const unsigned long int arg);

  virtual unsigned long int get_cache_max_size() const;

protected:
  std::string frame_defs_filename;

  std::string list_mode_filename;

  shared_ptr<ProjData> additive_proj_data_sptr;
  std::string additive_projection_data_filename;
  bool reduce_memory_usage;

  shared_ptr<BinNormalisation> normalisation_sptr;

  shared_ptr<ListModeData> list_mode_data_sptr;

  unsigned int current_frame_num;

  long int num_events_to_use;
  bool do_time_frame;


  void set_defaults() override;

  void initialise_keymap() override;

  bool post_processing() override;


  virtual void start_new_time_frame(const unsigned int new_frame_num);

  ParseAndCreateFrom<TargetT, ListModeData> target_parameter_parser;

  unsigned long int cache_size;
  bool cache_lm_file;
  bool recompute_cache;
  bool skip_lm_input_file;
  std::string cache_path;
  bool has_add;

  shared_ptr<ProjDataInfo> proj_data_info_sptr;

private:

  int max_segment_num_to_process;
};

END_NAMESPACE_STIR

//#include "stir/recon_buildblock/PoissonLogLikelihoodWithLinearModelForMean.inl"

#endif