PoissonLogLikelihoodWithLinearModelForMean.h

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2011-01-14, Hammersmith Imanet Ltd
    Copyright (C) 2012, Kris Thielemans

    SPDX-License-Identifier: Apache-2.0

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

#include "stir/recon_buildblock/GeneralisedObjectiveFunction.h"

START_NAMESPACE_STIR

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

public:
  // PoissonLogLikelihoodWithLinearModelForMean();


  void compute_sub_gradient_without_penalty(TargetT& gradient, const TargetT& current_estimate, const int subset_num) override;


  virtual void
  compute_sub_gradient_without_penalty_plus_sensitivity(TargetT& gradient, const TargetT& current_estimate, const int subset_num);


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

  const TargetT& get_sensitivity() const;
  const TargetT& get_subset_sensitivity(const int subset_num) const;

  virtual void add_subset_sensitivity(TargetT& sensitivity, const int subset_num) const = 0;


  bool get_use_subset_sensitivities() const;

  bool get_recompute_sensitivity() const;


  std::string get_sensitivity_filename() const;

  std::string get_subsensitivity_filenames() const;


  std::string get_subsensitivity_filename(const int subset_num) const;

  void set_recompute_sensitivity(const bool);
  void set_subset_sensitivity_sptr(const shared_ptr<TargetT>&, const int subset_num);

  void set_use_subset_sensitivities(const bool);


  void set_sensitivity_filename(const std::string&);

  void set_subsensitivity_filenames(const std::string&);

  void fill_nonidentifiable_target_parameters(TargetT& target, const float value) const override;

private:
  std::string sensitivity_filename;
  std::string subsensitivity_filenames;
  bool recompute_sensitivity;
  bool use_subset_sensitivities;

  VectorWithOffset<shared_ptr<TargetT>> subsensitivity_sptrs;
  shared_ptr<TargetT> sensitivity_sptr;

  shared_ptr<TargetT> get_subset_sensitivity_sptr(const int subset_num) const;

  void set_total_or_subset_sensitivities();

protected:
  virtual Succeeded set_up_before_sensitivity(shared_ptr<const TargetT> const& target_sptr) = 0;


  void compute_sensitivities();


  virtual void actual_compute_subset_gradient_without_penalty(TargetT& gradient,
                                                              const TargetT& current_estimate,
                                                              const int subset_num,
                                                              const bool add_sensitivity)
      = 0;


  void set_defaults() override;
  void initialise_keymap() override;
  bool post_processing() override;
};

END_NAMESPACE_STIR

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

#endif