FilterRootPrior.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_FilterRootPrior_H__
#define __stir_recon_buildblock_FilterRootPrior_H__

#include "stir/RegisteredParsingObject.h"
#include "stir/recon_buildblock/GeneralisedPrior.h"
#include "stir/shared_ptr.h"

START_NAMESPACE_STIR

template <typename DataT>
class DataProcessor;

template <typename DataT>
class FilterRootPrior : public RegisteredParsingObject<FilterRootPrior<DataT>, GeneralisedPrior<DataT>, GeneralisedPrior<DataT>>
{
private:
  typedef RegisteredParsingObject<FilterRootPrior<DataT>, GeneralisedPrior<DataT>, GeneralisedPrior<DataT>> base_type;

public:
  static const char* const registered_name;

  FilterRootPrior();

  FilterRootPrior(shared_ptr<DataProcessor<DataT>> const&, const float penalization_factor);

  bool is_convex() const override;


  double compute_value(const DataT& current_estimate) override;

  void compute_gradient(DataT& prior_gradient, const DataT& current_estimate) override;

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

protected:
  void check(DataT const& current_image_estimate) const override;

private:
  shared_ptr<DataProcessor<DataT>> filter_ptr;
  void set_defaults() override;
  void initialise_keymap() override;
};

END_NAMESPACE_STIR

#endif