ExamInfo.h

Go to the documentation of this file.

/*
    Copyright (C) 2021 National Physical Laboratory
    Copyright (C) 2013, 2018, 2020-2021 University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

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

#include "stir/PatientPosition.h"
#include "stir/TimeFrameDefinitions.h"
#include "stir/ImagingModality.h"
#include "stir/Radionuclide.h"
#include "stir/shared_ptr.h"

#include "stir/shared_ptr.h"

START_NAMESPACE_STIR

class ExamInfo
{

public:

  explicit ExamInfo(const ImagingModality modality = ImagingModality::Unknown)
      : imaging_modality(modality),
        start_time_in_secs_since_1970(0.),
        calibration_factor(-1.F),
        low_energy_thres(-1.F),
        up_energy_thres(-1.F)

  {}

  std::string originating_system;

  ImagingModality imaging_modality;

  PatientPosition patient_position;

  TimeFrameDefinitions time_frame_definitions;

  Radionuclide radionuclide;

  //  double branching_ratio;

  const TimeFrameDefinitions& get_time_frame_definitions() const { return time_frame_definitions; }
  TimeFrameDefinitions& get_time_frame_definitions() { return time_frame_definitions; }

  double start_time_in_secs_since_1970;


  inline float get_low_energy_thres() const;
  inline float get_high_energy_thres() const;
  inline float get_calibration_factor() const;
  inline Radionuclide get_radionuclide() const;


  inline void set_low_energy_thres(float new_val);
  inline void set_high_energy_thres(float new_val);

  inline void set_calibration_factor(const float cal_val);
  inline void set_radionuclide(const Radionuclide& arg);
  inline void set_energy_information_from(const ExamInfo&);

  inline bool has_energy_information() const { return (low_energy_thres > 0.f) && (up_energy_thres > 0.f); }

  inline ExamInfo* clone() const;
  inline shared_ptr<ExamInfo> create_shared_clone() const;

  void set_time_frame_definitions(const TimeFrameDefinitions& new_time_frame_definitions)
  {
    time_frame_definitions = new_time_frame_definitions;
  }

  bool operator==(const ExamInfo& p1) const;

  shared_ptr<ExamInfo> create_shared_clone() { return shared_ptr<ExamInfo>(new ExamInfo(*this)); }


  std::string parameter_info() const;

protected:
  float calibration_factor;

private:
  float low_energy_thres;

  float up_energy_thres;
};

END_NAMESPACE_STIR

#include "stir/ExamInfo.inl"

#endif // __stir_ExamInfo_H__