RelativeDifferencePrior.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    Copyright (C) 2019- 2020, UCL,
    This file is part of STIR.
 
    SPDX-License-Identifier: Apache-2.0
 
    See STIR/LICENSE.txt for details.
*/
 
#ifndef __stir_recon_buildblock_RelativeDifferencePrior_H__
#define __stir_recon_buildblock_RelativeDifferencePrior_H__
 
#include "stir/RegisteredParsingObject.h"
#include "stir/recon_buildblock/GeneralisedPrior.h"
#include "stir/Array.h"
#include "stir/DiscretisedDensity.h"
#include "stir/shared_ptr.h"
#include <string>
 
START_NAMESPACE_STIR

template <typename elemT>
class RelativeDifferencePrior : public RegisteredParsingObject<RelativeDifferencePrior<elemT>,
                                                               GeneralisedPrior<DiscretisedDensity<3, elemT>>,
                                                               GeneralisedPrior<DiscretisedDensity<3, elemT>>>
{
private:
  typedef RegisteredParsingObject<RelativeDifferencePrior<elemT>,
                                  GeneralisedPrior<DiscretisedDensity<3, elemT>>,
                                  GeneralisedPrior<DiscretisedDensity<3, elemT>>>
      base_type;
 
public:
  static const char* const registered_name;

  RelativeDifferencePrior();

  RelativeDifferencePrior(const bool only_2D, float penalization_factor, float gamma, float epsilon);

  double compute_value(const DiscretisedDensity<3, elemT>& current_image_estimate) override;

  void compute_gradient(DiscretisedDensity<3, elemT>& prior_gradient,
                        const DiscretisedDensity<3, elemT>& current_image_estimate) override;
 
  void compute_Hessian(DiscretisedDensity<3, elemT>& prior_Hessian_for_single_densel,
                       const BasicCoordinate<3, int>& coords,
                       const DiscretisedDensity<3, elemT>& current_image_estimate) const override;
 
  void add_multiplication_with_approximate_Hessian(DiscretisedDensity<3, elemT>& output,
                                                   const DiscretisedDensity<3, elemT>& input) const override;

  void accumulate_Hessian_times_input(DiscretisedDensity<3, elemT>& output,
                                      const DiscretisedDensity<3, elemT>& current_estimate,
                                      const DiscretisedDensity<3, elemT>& input) const override;

  float get_gamma() const;
  void set_gamma(float e);

  float get_epsilon() const;
  void set_epsilon(float e);

  Array<3, float> get_weights() const;

  void set_weights(const Array<3, float>&);


  shared_ptr<DiscretisedDensity<3, elemT>> get_kappa_sptr() const;

  void set_kappa_sptr(const shared_ptr<DiscretisedDensity<3, elemT>>&);

  virtual Succeeded set_up(shared_ptr<const DiscretisedDensity<3, elemT>> const& target_sptr) override;
 
  bool is_convex() const override;
 
protected:
  float gamma;

  float epsilon;

  bool only_2D;

  std::string gradient_filename_prefix;


  mutable Array<3, float> weights;
  std::string kappa_filename;

  void check(DiscretisedDensity<3, elemT> const& current_image_estimate) const override;
 
  void set_defaults() override;
  void initialise_keymap() override;
  bool post_processing() override;
 
protected:
  shared_ptr<DiscretisedDensity<3, elemT>> kappa_ptr;


  double value(const elemT x_j, const elemT x_k) const;
  elemT derivative_10(const elemT x, const elemT y) const;
  elemT derivative_20(const elemT x_j, const elemT x_k) const;
  elemT derivative_11(const elemT x_j, const elemT x_k) const;
};
 
END_NAMESPACE_STIR
 
#endif