GeneralisedPrior.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000- 2007, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

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

#include "stir/RegisteredObject.h"
#include "stir/ParsingObject.h"
#include "stir/Succeeded.h"

START_NAMESPACE_STIR

class Succeeded;

template <typename DataT>
class GeneralisedPrior : public RegisteredObject<GeneralisedPrior<DataT>>

{
public:
  inline GeneralisedPrior();


  virtual double compute_value(const DataT& current_estimate) = 0;


  virtual void compute_gradient(DataT& prior_gradient, const DataT& current_estimate) = 0;


  virtual double compute_gradient_times_input(const DataT& input, const DataT& current_estimate);


  virtual void compute_Hessian(DataT& prior_Hessian_for_single_densel,
                               const BasicCoordinate<3, int>& coords,
                               const DataT& current_image_estimate) const;


  virtual void compute_Hessian_diagonal(DataT& Hessian_diagonal, const DataT& current_estimate) const;


  virtual void add_multiplication_with_approximate_Hessian(DataT& output, const DataT& input) const;


  virtual void accumulate_Hessian_times_input(DataT& output, const DataT& current_estimate, const DataT& input) const;

  inline float get_penalisation_factor() const;
  inline void set_penalisation_factor(float new_penalisation_factor);

  virtual Succeeded set_up(shared_ptr<const DataT> const& target_sptr);


  virtual bool is_convex() const = 0;

protected:
  float penalisation_factor;

  void set_defaults() override;

  void initialise_keymap() override;

  virtual void check(DataT const& current_estimate) const;

  bool _already_set_up;
};

END_NAMESPACE_STIR

#include "stir/recon_buildblock/GeneralisedPrior.inl"

#endif