A class that reads the listmode data for GE scanners using the RDF9 format. More...

#include "stir/listmode/CListModeDataGEHDF5.h"

Inheritance diagram for stir::GE::RDF_HDF5::CListModeDataGEHDF5:

Public Member Functions
	CListModeDataGEHDF5 (const std::string &listmode_filename)
	Constructor taking a filename.

std::string	get_name () const override
	Returns the name of the list mode data. More...

virtual std::time_t	get_scan_start_time_in_secs_since_1970 () const

shared_ptr< CListRecord >	get_empty_record_sptr () const override
	Get a pointer to an empty record. More...

Succeeded	get_next_record (CListRecord &record) const override
	Gets the next record in the listmode sequence.

Succeeded	reset () override
	Call this function if you want to re-start reading at the beginning.

SavedPosition	save_get_position () override
	Save the current reading position. More...

Succeeded	set_get_position (const SavedPosition &) override
	Set the position for reading to a previously saved point.

bool	has_delayeds () const override
	returns `false`, as GEHDF5 listmode data does not store delayed events (and prompts) More...

Public Member Functions inherited from stir::ListModeData
	ListModeData ()
	Default constructor.

shared_ptr< ListRecord >	get_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.

const Scanner &	get_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 ProjDataInfo >	get_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 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 More...

void	set_exam_info_sptr (shared_ptr< const ExamInfo > new_exam_info_sptr)

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 Member Functions inherited from stir::CListModeData
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 >)

Protected Attributes inherited from stir::ListModeData
shared_ptr< const ProjDataInfo >	proj_data_info_sptr
	Has to be set by the derived class. More...

Protected Attributes inherited from stir::ExamData
shared_ptr< const ExamInfo >	exam_info_sptr

Detailed Description

A class that reads the listmode data for GE scanners using the RDF9 format.

This file format is used by GE Signa PET/MR and can be used by GE PET/CT scanners (D690 up to DMI) depending on software version.

Member Function Documentation

◆ get_name()

std::string stir::GE::RDF_HDF5::CListModeDataGEHDF5::get_name ( ) const

overridevirtual

Returns the name of the list mode data.

This name is not necessarily unique, and might be empty. However, it is expected (but not guaranteed) that ListModeData::read_from_file(lm_data_ptr->get_name()) would read the same list mode data.

The reason this cannot be guaranteed is largely in case the list mode data is not really on disk, but the object corresponds for instance to a Monte Carlo simulator.

Implements stir::ListModeData.

◆ get_empty_record_sptr()

shared_ptr< CListRecord > stir::GE::RDF_HDF5::CListModeDataGEHDF5::get_empty_record_sptr ( ) const

overridevirtual

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().

Implements stir::CListModeData.

References stir::GE::RDF_HDF5::GEHDF5Wrapper::check_GE_signature(), stir::error(), stir::GE::RDF_HDF5::GEHDF5Wrapper::get_exam_info_sptr(), stir::info(), and stir::ExamData::set_exam_info().

◆ save_get_position()

CListModeData::SavedPosition stir::GE::RDF_HDF5::CListModeDataGEHDF5::save_get_position ( )

overridevirtual

Save the current reading position.

Note that the return value is not related to the number of events already read. In particular, you cannot do any arithmetic on it to skip a few events. This is different from e.g. std::streampos.

Warning: There is a maximum number of times this function can be called. This is determined by the SavedPosition type. Once you save more positions, the first positions will be overwritten. There is currently no way of finding out after how many times this will happen (but it's a large number...).; These saved positions are only valid for the lifetime of the ListModeData object.; A derived class might disable this facility. It will/should then always return Succeeded::no when calling set_get_position().

Implements stir::ListModeData.

◆ has_delayeds()

bool stir::GE::RDF_HDF5::CListModeDataGEHDF5::has_delayeds ( ) const

inlineoverridevirtual

returns false, as GEHDF5 listmode data does not store delayed events (and prompts)

Todo:: this depends on the acquisition parameters

Implements stir::CListModeData.

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

/home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/listmode/CListModeDataGEHDF5.h
/home/sirfuser/devel/STIRdistrib/STIR/src/listmode_buildblock/CListModeDataGEHDF5.cxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_name()

◆ get_empty_record_sptr()

◆ save_get_position()

◆ has_delayeds()