PLSPrior.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2018 University of Leeds and University College of London
 
    This file is part of STIR.
 
    SPDX-License-Identifier: Apache-2.0
 
    See STIR/LICENSE.txt for details.
*/
 
#ifndef __stir_recon_buildblock_PLSPrior_H__
#define __stir_recon_buildblock_PLSPrior_H__
 
#include "stir/RegisteredParsingObject.h"
#include "stir/recon_buildblock/PriorWithParabolicSurrogate.h"
#include "stir/Array.h"
#include "stir/DiscretisedDensity.h"
#include "stir/shared_ptr.h"
#include <string>
 
START_NAMESPACE_STIR

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

  PLSPrior();

  PLSPrior(const bool only_2D, float penalization_factor);


  Succeeded set_up(shared_ptr<const DiscretisedDensity<3, elemT>> const& target_sptr) override;
 
  bool is_convex() const override;

  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;


  shared_ptr<const DiscretisedDensity<3, elemT>> get_kappa_sptr() const;
  shared_ptr<const DiscretisedDensity<3, elemT>> get_anatomical_grad_sptr(int direction) const;
  shared_ptr<const DiscretisedDensity<3, elemT>> get_norm_sptr() const;

  double get_eta() const;
  double get_alpha() const;

  void set_eta(const double);
  void set_alpha(const double);

  void set_anatomical_image_sptr(const shared_ptr<const DiscretisedDensity<3, elemT>>&);
  shared_ptr<const DiscretisedDensity<3, elemT>> get_anatomical_image_sptr() const;
  void set_anatomical_filename(const std::string& filename);

  void set_kappa_sptr(const shared_ptr<const DiscretisedDensity<3, elemT>>&);
  void set_kappa_filename(const std::string& filename);

  void set_only_2D(const bool arg) { only_2D = arg; }
  bool get_only_2D() { return only_2D; }
 
protected:
  bool only_2D;

  std::string gradient_filename_prefix;

  std::string kappa_filename;
  std::string anatomical_filename;
 
  double eta, alpha;
 
  void set_defaults() override;
  void initialise_keymap() override;

  bool post_processing() override;

  void check(DiscretisedDensity<3, elemT> const& current_image_estimate) const override;
 
private:
  static void compute_image_gradient_element(DiscretisedDensity<3, elemT>& image_gradient_elem,
                                             int direction,
                                             const DiscretisedDensity<3, elemT>& image);

  void compute_normalisation_anatomical_gradient(DiscretisedDensity<3, elemT>& norm_im_grad,
                                                 const DiscretisedDensity<3, elemT>& image_grad_z,
                                                 const DiscretisedDensity<3, elemT>& image_grad_y,
                                                 const DiscretisedDensity<3, elemT>& image_grad_x);
  void compute_inner_product_and_penalty(DiscretisedDensity<3, elemT>& inner_product,
                                         DiscretisedDensity<3, elemT>& penalty,
                                         DiscretisedDensity<3, elemT>& pet_im_grad_z,
                                         DiscretisedDensity<3, elemT>& pet_im_grad_y,
                                         DiscretisedDensity<3, elemT>& pet_im_grad_x,
                                         const DiscretisedDensity<3, elemT>& pet_image);
 
  shared_ptr<const DiscretisedDensity<3, elemT>> anatomical_grad_x_sptr;
  shared_ptr<const DiscretisedDensity<3, elemT>> anatomical_grad_y_sptr;
  shared_ptr<const DiscretisedDensity<3, elemT>> anatomical_grad_z_sptr;
  shared_ptr<const DiscretisedDensity<3, elemT>> anatomical_sptr;
  shared_ptr<const DiscretisedDensity<3, elemT>> norm_sptr;
  shared_ptr<const DiscretisedDensity<3, elemT>> kappa_ptr;
  void set_anatomical_grad_sptr(const shared_ptr<const DiscretisedDensity<3, elemT>>&, int);
  void set_anatomical_grad_norm_sptr(const shared_ptr<const DiscretisedDensity<3, elemT>>&);
};
 
END_NAMESPACE_STIR
 
#endif