STIR  6.2.0
Public Member Functions | Protected Member Functions | List of all members
stir::SPECTListModeData Class Referenceabstract

The base class for reading SPECT list mode data.This class (and SPECTListRecord) is specific to SPECT, i.e. to single gamma detection. However, the only difference with the PET part are the functions related to prompts and delayeds. SPECT is handled by calling all single photon events 'prompts'. More...

#include "stir/listmode/SPECTListModeData.h"

Inheritance diagram for stir::SPECTListModeData:
Inheritance graph
[legend]

Public Member Functions

virtual shared_ptr< SPECTListRecordget_empty_record_sptr () const =0
 Get a pointer to an empty record. More...
 
virtual Succeeded get_next_record (SPECTListRecord &event) const =0
 Gets the next record in the listmode sequence.
 
virtual bool has_delayeds () const
 Return if the file stores delayed events as well (as opposed to prompts)
 
- Public Member Functions inherited from stir::ListModeData
 ListModeData ()
 Default constructor.
 
virtual std::string get_name () const =0
 Returns the name of the list mode data. More...
 
shared_ptr< ListRecordget_empty_record_sptr () const
 Get a pointer to an empty record. More...
 
virtual Succeeded get_next_record (ListRecord &event) const
 Gets the next record in the listmode sequence.
 
virtual Succeeded reset ()=0
 Call this function if you want to re-start reading at the beginning.
 
virtual SavedPosition save_get_position ()=0
 Save the current reading position. More...
 
virtual Succeeded set_get_position (const SavedPosition &)=0
 Set the position for reading to a previously saved point.
 
const Scannerget_scanner () const
 Get reference to scanner. More...
 
virtual unsigned long int get_total_number_of_events () const
 Returns the total number of events in the listmode file. More...
 
virtual shared_ptr< const ProjDataInfoget_proj_data_info_sptr () const
 
- Public Member Functions inherited from stir::ExamData
 ExamData ()
 ExamData. More...
 
 ExamData (const shared_ptr< const ExamInfo > &_this_exam)
 
virtual const ExamInfoget_exam_info () const
 
virtual shared_ptr< const ExamInfoget_exam_info_sptr () const
 Get shared pointer to exam info.
 
virtual void set_exam_info (ExamInfo const &)
 change exam info More...
 
void set_exam_info_sptr (shared_ptr< const ExamInfo > new_exam_info_sptr)
 

Protected Member Functions

virtual shared_ptr< ListRecordget_empty_record_helper_sptr () const
 
virtual Succeeded get_next (ListRecord &event) const
 
- Protected Member Functions inherited from stir::ListModeData
virtual void set_proj_data_info_sptr (shared_ptr< const ProjDataInfo >)
 

Additional Inherited Members

- Public Types inherited from stir::ListModeData
typedef ListModeData hierarchy_base_type
 typedef used by read_from_file
 
typedef unsigned int SavedPosition
 Use this typedef for save/set_get_position.
 
- Protected Attributes inherited from stir::ListModeData
shared_ptr< const ProjDataInfoproj_data_info_sptr
 Has to be set by the derived class. More...
 
- Protected Attributes inherited from stir::ExamData
shared_ptr< const ExamInfoexam_info_sptr
 

Detailed Description

The base class for reading SPECT list mode data.

This class (and SPECTListRecord) is specific to SPECT, i.e. to single gamma detection. However, the only difference with the PET part are the functions related to prompts and delayeds. SPECT is handled by calling all single photon events 'prompts'.

Member Function Documentation

◆ get_empty_record_sptr()

virtual shared_ptr<SPECTListRecord> stir::SPECTListModeData::get_empty_record_sptr ( ) const
pure virtual

Get a pointer to an empty record.

This is mainly/only useful to get a record of the correct type, that can then be passed to get_next_record().


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