SqrtHessianRowSum.h

Go to the documentation of this file.

/*
    Copyright (C) 2020, University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/

#ifndef STIR_SQRTHESSIANROWSUM_H
#define STIR_SQRTHESSIANROWSUM_H

#include "stir/info.h"
#include "stir/IO/OutputFileFormat.h"
#include "stir/IO/read_from_file.h"
#include "stir/is_null_ptr.h"
#include "stir/recon_buildblock/GeneralisedObjectiveFunction.h"
#include "stir/recon_buildblock/GeneralisedPrior.h"
#include "stir/recon_buildblock/PoissonLogLikelihoodWithLinearModelForMeanAndProjData.h"
#include "stir/recon_buildblock/PoissonLogLikelihoodWithLinearModelForMeanAndGatedProjDataWithMotion.h"
#include "stir/recon_buildblock/PoissonLogLikelihoodWithLinearKineticModelAndDynamicProjectionData.h"

START_NAMESPACE_STIR

class Succeeded;

template <typename TargetT>
class SqrtHessianRowSum : public ParsingObject
{
public:

  SqrtHessianRowSum();
  explicit SqrtHessianRowSum(const std::string&);


  void set_defaults() override;


  void process_data();


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


  shared_ptr<TargetT> get_input_image_sptr();
  void set_input_image_sptr(shared_ptr<TargetT> const& image);

  shared_ptr<TargetT> get_output_target_sptr();

  void set_up();


  bool get_use_approximate_hessian() const;
  void set_use_approximate_hessian(bool use_approximate);


  bool get_compute_with_penalty() const;
  void set_compute_with_penalty(bool with_penalty);

  void compute_Hessian_row_sum();

  void compute_approximate_Hessian_row_sum();

protected:
  bool _already_setup = false;

private:
  shared_ptr<GeneralisedObjectiveFunction<TargetT>> objective_function_sptr;

  std::string output_filename;

  std::string input_image_filename;

  shared_ptr<TargetT> input_image_sptr;

  shared_ptr<TargetT> output_target_sptr;

  bool use_approximate_hessian;

  bool compute_with_penalty;

  shared_ptr<OutputFileFormat<TargetT>> output_file_format_sptr;

  int _verbosity;

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

END_NAMESPACE_STIR
#endif // STIR_SQRTHESSIANROWSUM_H