IterativeReconstruction.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    Copyright (C) 2018, University College London
    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_recon_buildblock_IterativeReconstruction_h__
#  define __stir_recon_buildblock_IterativeReconstruction_h__

/* Modification history

   KT 10122001
   - added get_initial_data_ptr and 0 argument reconstruct()
*/
#  include "stir/recon_buildblock/Reconstruction.h"
#  include "stir/shared_ptr.h"
#  include "stir/DataProcessor.h"
#  include "stir/recon_buildblock/GeneralisedObjectiveFunction.h"

START_NAMESPACE_STIR

template <class TargetT>
class IterativeReconstruction : public Reconstruction<TargetT>
{
private:
  typedef Reconstruction<TargetT> base_type;

public:
  int get_subiteration_num() const { return subiteration_num; }


  int get_subset_num();


  virtual TargetT* get_initial_data_ptr() const;


  Succeeded reconstruct() override;


  Succeeded reconstruct(shared_ptr<TargetT> const& target_data_sptr) override;


  std::string make_filename_prefix_subiteration_num(const std::string& filename_prefix) const;


  std::string make_filename_prefix_subiteration_num() const;

  GeneralisedObjectiveFunction<TargetT> const& get_objective_function() const;

  shared_ptr<GeneralisedObjectiveFunction<TargetT>> get_objective_function_sptr() const;

  const int get_max_num_full_iterations() const;

  const int get_num_subsets() const;

  const int get_num_subiterations() const;

  const int get_start_subiteration_num() const;

  const int get_start_subset_num() const;

  // TODO rename
  const int get_save_interval() const;

  const bool get_randomise_subset_order() const;

  const DataProcessor<TargetT>& get_inter_iteration_filter() const;

  shared_ptr<DataProcessor<TargetT>> get_inter_iteration_filter_sptr();

  const int get_inter_iteration_filter_interval() const;

  const int get_report_objective_function_values_interval() const;

  void set_objective_function_sptr(const shared_ptr<GeneralisedObjectiveFunction<TargetT>>&);

  void set_max_num_full_iterations(const int);

  void set_num_subsets(const int);

  void set_num_subiterations(const int);

  void set_start_subiteration_num(const int);

  void set_start_subset_num(const int);

  // TODO rename
  void set_save_interval(const int);

  void set_randomise_subset_order(const bool);

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

  void set_inter_iteration_filter_interval(const int);

  void set_report_objective_function_values_interval(const int);

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

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

  virtual void update_estimate(TargetT& current_estimate) = 0;

protected:
  IterativeReconstruction();


  // KT 14/12/2001 remove =0 as it's not a pure virtual and the default implementation is usually fine.
  virtual void end_of_iteration_processing(TargetT& current_estimate);

  shared_ptr<GeneralisedObjectiveFunction<TargetT>> objective_function_sptr;

  int subiteration_num;

  bool terminate_iterations;

  // parameters
protected:
  int max_num_full_iterations;

  int num_subsets;

  int num_subiterations;

  int start_subiteration_num;

  std::string initial_data_filename;

  int start_subset_num;

  // TODO rename

  int save_interval;

  bool randomise_subset_order;

  shared_ptr<DataProcessor<TargetT>> inter_iteration_filter_ptr;

  int inter_iteration_filter_interval;


  int report_objective_function_values_interval;

  virtual void ask_parameters();

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

private:

  VectorWithOffset<int> _current_subset_array;
  VectorWithOffset<int> randomly_permute_subset_order() const;
};

END_NAMESPACE_STIR

#endif
// __IterativeReconstruction_h__