The base-class for using singles info. More...
#include "stir/data/SinglesRates.h"
Public Member Functions | |
| virtual float | get_singles_rate (const int singles_bin_index, const double start_time, const double end_time) const |
| Get the (average) singles rate for a particular singles unit and a frame with the specified start and end times. More... | |
| virtual float | get_singles (const int singles_bin_index, const double start_time, const double end_time) const =0 |
| Get the number of singles for a particular singles unit and a frame with the specified start and end times. More... | |
| virtual float | get_singles_rate (const DetectionPosition<> &det_pos, const double start_time, const double end_time) const |
| Virtual function that returns the average singles rate given the detection positions and time-interval of detection. More... | |
| virtual float | get_singles (const DetectionPosition<> &det_pos, const double start_time, const double end_time) const |
| Virtual function that returns the number of singles given the detection positions and time-interval of detection. More... | |
| const Scanner * | get_scanner_ptr () const |
| Get the scanner pointer. | |
 Public Member Functions inherited from stir::RegisteredObjectBase | |
| virtual std::string | get_registered_name () const =0 |
| Returns the name of the type of the object. More... | |
| Public Member Functions inherited from stir::ParsingObject | |
| ParsingObject (const ParsingObject &) | |
| ParsingObject & | operator= (const ParsingObject &) |
| void | ask_parameters () |
| virtual std::string | parameter_info () |
| bool | parse (std::istream &f) |
| bool | parse (const char *const filename) |
Protected Attributes | |
| shared_ptr< Scanner > | scanner_sptr |
| Generate a FramesSinglesRate - containing the average rates. | |
| Protected Attributes inherited from stir::ParsingObject | |
| KeyParser | parser |
Additional Inherited Members | |
| Static Public Member Functions inherited from stir::RegisteredObject< SinglesRates > | |
| static SinglesRates * | read_registered_object (std::istream *in, const std::string ®istered_name) |
| Construct a new object (of a type derived from Root, its actual type determined by the registered_name parameter) by parsing the istream. More... | |
| static SinglesRates * | ask_type_and_parameters () |
| ask the user for the type, and then calls read_registered_object(0, type) More... | |
| static void | list_registered_names (std::ostream &stream) |
| List all possible registered names to the stream. More... | |
| Protected Types inherited from stir::RegisteredObject< SinglesRates > | |
| typedef SinglesRates *(* | RootFactory) (std::istream *) |
| The type of a root factory is a function, taking an istream* as argument, and returning a Root*. | |
| typedef FactoryRegistry< std::string, RootFactory, interfile_less > | RegistryType |
| The type of the registry. | |
| Protected Member Functions inherited from stir::ParsingObject | |
| virtual void | set_defaults () |
| Set defaults before parsing. | |
| virtual void | initialise_keymap () |
| Initialise all keywords. | |
| virtual bool | post_processing () |
| This will be called at the end of the parsing. More... | |
| virtual void | set_key_values () |
| This will be called before parsing or parameter_info is called. More... | |
| Static Protected Member Functions inherited from stir::RegisteredObject< SinglesRates > | |
| static RegistryType & | registry () |
| Static function returning the registry. More... | |
Detailed Description
The base-class for using singles info.
Singles in PET are photons detected by a single detector. In PET they are useful to estimate dead-time or randoms.
This class allows to get the singles-counts during an acquisition. There will be 1 per singles unit. See Scanner for some more info.
Member Function Documentation
◆ get_singles_rate() [1/2]
|
virtual |
Get the (average) singles rate for a particular singles unit and a frame with the specified start and end times.
The behaviour of this function is specified by the derived classes.
- Warning
- Currently might return -1 if the start_time, end_time are invalid (e.g. out of the measured range).
Default implementation uses get_singles(...)/(end_time-start_time).
◆ get_singles() [1/2]
|
pure virtual |
Get the number of singles for a particular singles unit and a frame with the specified start and end times.
The behaviour of this function is specified by the derived classes.
- Warning
- Currently might return -1 if the start_time, end_time are invalid (e.g. out of the measured range).
Implemented in stir::SinglesRatesForTimeFrames, and stir::SinglesRatesForTimeSlices.
Referenced by stir::randoms_from_singles().
◆ get_singles_rate() [2/2]
|
virtual |
Virtual function that returns the average singles rate given the detection positions and time-interval of detection.
The behaviour of this function is specified by the derived classes.
- Warning
- Currently might return -1 if the start_time, end_time are invalid (e.g. out of the measured range).
Default implementation uses Scanner::get_singles_bin_index() and get_singles_rate(int,double,double).
References stir::FrameSinglesRates::get_singles_rate().
◆ get_singles() [2/2]
|
virtual |
Virtual function that returns the number of singles given the detection positions and time-interval of detection.
The behaviour of this function is specified by the derived classes.
- Warning
- Currently might return -1 if the start_time, end_time are invalid (e.g. out of the measured range).
Default implementation uses Scanner::get_singles_bin_index() and get_singles(int,double,double).
The documentation for this class was generated from the following files:
- /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/data/SinglesRates.h
- /home/sirfuser/devel/STIRdistrib/STIR/src/data_buildblock/SinglesRates.cxx
- /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/data/SinglesRates.inl
