stir::ExamInfo Class Reference

a class for storing information about 1 exam (or scan) More...

#include "stir/ExamInfo.h"

Public Member Functions
	ExamInfo (const ImagingModality modality=ImagingModality::Unknown)
	Default constructor.
const TimeFrameDefinitions &	get_time_frame_definitions () const
TimeFrameDefinitions &	get_time_frame_definitions ()
Functions that return info related on the acquisition settings
float	get_low_energy_thres () const
	Get the low energy boundary.
float	get_high_energy_thres () const
	Get the high energy boundary.
float	get_calibration_factor () const
	Get the calibration factor.
Radionuclide	get_radionuclide () const
	Get the radionuclide name.

Public Attributes
std::string	originating_system
ImagingModality	imaging_modality
PatientPosition	patient_position
TimeFrameDefinitions	time_frame_definitions
Radionuclide	radionuclide
double	start_time_in_secs_since_1970

Functions that set values related on the acquisition settings
float	calibration_factor
void	set_low_energy_thres (float new_val)
	Set the low energy boundary.
void	set_high_energy_thres (float new_val)
	Set the high energy boundary.
void	set_calibration_factor (const float cal_val)
	Set the Calibration factor.
void	set_radionuclide (const Radionuclide &arg)
	Set the radionuclide.
void	set_energy_information_from (const ExamInfo &)
	Copy energy information from another ExamInfo.
bool	has_energy_information () const
ExamInfo *	clone () const
	Standard trick for a 'virtual copy-constructor'.
shared_ptr< ExamInfo >	create_shared_clone () const
	Like clone() but return a shared_ptr.
void	set_time_frame_definitions (const TimeFrameDefinitions &new_time_frame_definitions)
bool	operator== (const ExamInfo &p1) const
	Warning: the operator == does not check that originating system is consistent!
shared_ptr< ExamInfo >	create_shared_clone ()
	Clone and create shared_ptr of the copy.
std::string	parameter_info () const
	Return a string with info on parameters.

Detailed Description

a class for storing information about 1 exam (or scan)

Todo

this is very incomplete at the moment. Things like bed positions, gating, isotopes etc etc are all missing

Todo

This should be an abtract registered object, in order to serve as a complete base function for every input data type.

Constructor & Destructor Documentation

ExamInfo()

stir::ExamInfo::ExamInfo ( const ImagingModality modality = ImagingModality::Unknown )

inlineexplicit

Default constructor.

Most fields take their default values (which might be invalid). start_time_in_secs_since_1970 is set to zero, energy window info to -1, to indicate that it is not initialised.

Referenced by clone(), create_shared_clone(), operator==(), and set_energy_information_from().

Member Function Documentation

parameter_info()

std::string stir::ExamInfo::parameter_info

(

)

const

Return a string with info on parameters.

the returned string is not intended for parsing.

References get_high_energy_thres(), get_low_energy_thres(), parameter_info(), and stir::secs_since_Unix_epoch_to_Interfile_datetime().

Referenced by parameter_info().

---

The documentation for this class was generated from the following files:

• /home/kris/devel/STIRdistrib/STIR/src/include/stir/ExamInfo.h
• /home/kris/devel/STIRdistrib/STIR/src/buildblock/ExamInfo.cxx
• /home/kris/devel/STIRdistrib/STIR/src/include/stir/ExamInfo.inl