OSMAPOSLReconstruction.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000 - 2007-10-08, Hammersmith Imanet Ltd
    Copyright (C) 2012-06-05 - 2012, Kris Thielemans
    Copyright (C) 2018 Commonwealth Scientific and Industrial Research Organisation
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

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

#  include "stir/recon_buildblock/IterativeReconstruction.h"
#  include "stir/RegisteredParsingObject.h"

START_NAMESPACE_STIR

template <typename TargetT>
class PoissonLogLikelihoodWithLinearModelForMean;

template <typename TargetT>
class OSMAPOSLReconstruction
    : public RegisteredParsingObject<OSMAPOSLReconstruction<TargetT>, Reconstruction<TargetT>, IterativeReconstruction<TargetT>>
// public IterativeReconstruction<TargetT >
{
private:
  typedef RegisteredParsingObject<OSMAPOSLReconstruction<TargetT>, Reconstruction<TargetT>, IterativeReconstruction<TargetT>>
      base_type;

public:
  static const char* const registered_name;

  OSMAPOSLReconstruction();
  explicit OSMAPOSLReconstruction(const std::string& parameter_filename);

  OSMAPOSLReconstruction& get_parameters() { return *this; }

  const OSMAPOSLReconstruction& get_parameters() const { return *this; }

  std::string method_info() const override;

  /* Overloading IterativeReconstruction::get_objective_function()
     with a return-type specifying it'll always be a Poisson log likelihood.
  */
  PoissonLogLikelihoodWithLinearModelForMean<TargetT> const& get_objective_function() const;

  void set_inter_update_filter_interval(const int);

  void set_inter_update_filter_ptr(const shared_ptr<DataProcessor<TargetT>>&);

  void set_maximum_relative_change(const double);

  void set_minimum_relative_change(const double);

  void set_enforce_initial_positivity(const bool);

  void set_write_update_image(const int);

  void set_MAP_model(const std::string&);

  void ask_parameters() override;

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

  void update_estimate(TargetT& current_image_estimate) override;

protected:
  // virtual Succeeded set_up(shared_ptr <TargetT > const& target_image_ptr);

  bool enforce_initial_positivity;


  bool do_rim_truncation;

  int inter_update_filter_interval;

  shared_ptr<DataProcessor<TargetT>> inter_update_filter_ptr;

  // KT 17/08/2000 3 new parameters

  double maximum_relative_change;

  double minimum_relative_change;

  int write_update_image;

  std::string MAP_model;

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

  bool post_processing() override;

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

  virtual const TargetT& get_subset_sensitivity(const int subset_num);

  virtual void apply_multiplicative_update(TargetT& current_image_estimate, const TargetT& multiplicative_update_image);

private:
  friend void do_sensitivity(const char* const par_filename);

  // virtual void update_estimate (TargetT& current_image_estimate);

  PoissonLogLikelihoodWithLinearModelForMean<TargetT>& objective_function();

  PoissonLogLikelihoodWithLinearModelForMean<TargetT> const& objective_function() const;

  unique_ptr<TargetT> multiplicative_update_image_ptr;
};

END_NAMESPACE_STIR

#endif

// __OSMAPOSLReconstruction_h__