Reconstruction.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2007, Hammersmith Imanet Ltd
    Copyright (C) 2018, University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

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

#include "stir/TimedObject.h"
#include "stir/ParsingObject.h"
#include "stir/shared_ptr.h"
#include "stir/DataProcessor.h"
#include "stir/IO/OutputFileFormat.h"
#include "stir/RegisteredObject.h"
#include <string>

#include "stir/ExamData.h"

START_NAMESPACE_STIR

class Succeeded;

template <typename TargetT>
class Reconstruction : public RegisteredObject<Reconstruction<TargetT>>, public TimedObject
{
public:
  Reconstruction();

  ~Reconstruction() override{};

  virtual std::string method_info() const = 0;


  virtual Succeeded reconstruct() = 0;


  virtual Succeeded reconstruct(shared_ptr<TargetT> const& target_image_sptr) = 0;


  virtual Succeeded set_up(shared_ptr<TargetT> const& target_data_sptr);


  void set_output_filename_prefix(const std::string&);

  void set_output_file_format_ptr(const shared_ptr<OutputFileFormat<TargetT>>&);

  void set_post_processor_sptr(const shared_ptr<DataProcessor<TargetT>>&);

  virtual void set_input_data(const shared_ptr<ExamData>&) = 0;

  virtual const ExamData& get_input_data() const = 0;

  void set_disable_output(bool _val);

  shared_ptr<TargetT> get_target_image();

  // parameters
protected:
  std::string output_filename_prefix;

  shared_ptr<OutputFileFormat<TargetT>> output_file_format_ptr;

  shared_ptr<DataProcessor<TargetT>> post_filter_sptr;

protected:

  virtual void check(TargetT const& target_data) const;
  bool _already_set_up;

  void initialise(const std::string& parameter_filename);

  void set_defaults() override;
  void initialise_keymap() override;

  bool post_processing() override;

  shared_ptr<TargetT> target_data_sptr;

  bool _disable_output;

  int _verbosity;
};

END_NAMESPACE_STIR

#endif