stir::CListModeData Class Reference

The base class for reading PET (i.e. coincidence) list mode data. More...

#include "stir/listmode/CListModeData.h"

Inheritance diagram for stir::CListModeData:

Public Member Functions
virtual shared_ptr< CListRecord >	get_empty_record_sptr () const =0
	Get a pointer to an empty record.
virtual Succeeded	get_next_record (CListRecord &event) const =0
	Gets the next record in the listmode sequence.
bool	has_delayeds () const override=0
	Return if the file stores delayed events as well (as opposed to prompts)
Public Member Functions inherited from stir::ListModeData
	ListModeData ()
	Default constructor.
	ListModeData (shared_ptr< const ExamInfo > exam_info_sptr, shared_ptr< const ProjDataInfo > proj_data_info_sptr)
virtual std::string	get_name () const =0
	Returns the name of the list mode data.
shared_ptr< ListRecord >	get_empty_record_sptr () const
	Get a pointer to an empty record.
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.
virtual Succeeded	set_get_position (const SavedPosition &)=0
	Set the position for reading to a previously saved point.
const Scanner &	get_scanner () const
	Get reference to scanner.
virtual unsigned long int	get_total_number_of_events () const
	Returns the total number of events in the listmode file.
Public Member Functions inherited from stir::ExamData
	ExamData ()
	ExamData.
	ExamData (const shared_ptr< const ExamInfo > &_this_exam)
virtual const ExamInfo &	get_exam_info () const
virtual shared_ptr< const ExamInfo >	get_exam_info_sptr () const
	Get shared pointer to exam info.
virtual void	set_exam_info (ExamInfo const &)
	change exam info
void	set_exam_info_sptr (shared_ptr< const ExamInfo > new_exam_info_sptr)
Public Member Functions inherited from stir::DataWithProjDataInfo
	DataWithProjDataInfo ()
	Default constructor sets internal member to 0.
	DataWithProjDataInfo (const shared_ptr< const ProjDataInfo > &proj_data_info_sptr_v)
virtual const ProjDataInfo &	get_proj_data_info () const
virtual shared_ptr< const ProjDataInfo >	get_proj_data_info_sptr () const
	Get shared pointer to ProjData info.
int	get_num_segments () const
	Get number of segments.
int	get_num_axial_poss (const int segment_num) const
	Get number of axial positions per segment.
int	get_num_views () const
	Get number of views.
int	get_num_tangential_poss () const
	Get number of tangential positions.
int	get_num_tof_poss () const
	Get number of TOF positions.
int	get_min_tof_pos_num () const
	Get the index of the first timing position.
int	get_max_tof_pos_num () const
	Get the index of the last timing position.
int	get_tof_mash_factor () const
	Get TOG mash factor.
int	get_min_segment_num () const
	Get minimum segment number.
int	get_max_segment_num () const
	Get maximum segment number.
int	get_min_axial_pos_num (const int segment_num) const
	Get mininum axial position per segmnet.
int	get_max_axial_pos_num (const int segment_num) const
	Get maximum axial position per segment.
int	get_min_view_num () const
	Get minimum view number.
int	get_max_view_num () const
	Get maximum view number.
int	get_min_tangential_pos_num () const
	Get minimum tangential position number.
int	get_max_tangential_pos_num () const
	Get maximum tangential position number.

Protected Member Functions
shared_ptr< ListRecord >	get_empty_record_helper_sptr () const override
Succeeded	get_next (ListRecord &event) const override
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::ExamData
shared_ptr< const ExamInfo >	exam_info_sptr
Protected Attributes inherited from stir::DataWithProjDataInfo
shared_ptr< const ProjDataInfo >	proj_data_info_sptr

Detailed Description

The base class for reading PET (i.e. coincidence) list mode data.

The only difference w.r.t. ListModeData is the used of CListRecord and a virtual function to check if delayeds are present.

Member Function Documentation

get_empty_record_sptr()

virtual shared_ptr< CListRecord > stir::CListModeData::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().

Implemented in stir::CListModeDataLMF, stir::CListModeDataPENN, stir::CListModeDataROOT, stir::CListModeDataSAFIR< CListRecordT >, stir::ecat::CListModeDataECAT8_32bit, stir::ecat::ecat7::CListModeDataECAT< CListRecordT >, and stir::GE::RDF_HDF5::CListModeDataGEHDF5.

Referenced by has_delayeds().

get_next_record()

virtual Succeeded stir::CListModeData::get_next_record ( CListRecord & event ) const

pure virtual

Gets the next record in the listmode sequence.

Implemented in stir::CListModeDataLMF, stir::CListModeDataPENN, stir::CListModeDataROOT, stir::CListModeDataSAFIR< CListRecordT >, stir::ecat::CListModeDataECAT8_32bit, stir::ecat::ecat7::CListModeDataECAT< CListRecordT >, and stir::GE::RDF_HDF5::CListModeDataGEHDF5.

has_delayeds()

bool stir::CListModeData::has_delayeds ( ) const

overridepure virtual

Return if the file stores delayed events as well (as opposed to prompts)

Implements stir::ListModeData.

Implemented in stir::CListModeDataLMF, stir::CListModeDataPENN, stir::CListModeDataROOT, stir::CListModeDataSAFIR< CListRecordT >, stir::ecat::CListModeDataECAT8_32bit, stir::ecat::ecat7::CListModeDataECAT< CListRecordT >, and stir::GE::RDF_HDF5::CListModeDataGEHDF5.

References get_empty_record_sptr().

get_empty_record_helper_sptr()

shared_ptr< ListRecord > stir::CListModeData::get_empty_record_helper_sptr ( ) const

inlineoverrideprotectedvirtual

Implements stir::ListModeData.

get_next()

Succeeded stir::CListModeData::get_next ( ListRecord & event ) const

inlineoverrideprotectedvirtual

Implements stir::ListModeData.

---

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

• /home/kris/devel/STIRdistrib/STIR/src/include/stir/listmode/CListModeData.h