A BinNormalisation class that gets the normalisation factors from an GEHDF5 3D normalisation file. More...

#include "stir/recon_buildblock/BinNormalisationFromGEHDF5.h"

Inheritance diagram for stir::GE::RDF_HDF5::BinNormalisationFromGEHDF5:

[legend]

Public Member Functions
	BinNormalisationFromGEHDF5 ()
	Default constructor. More...

	BinNormalisationFromGEHDF5 (const string &filename)
	Constructor that reads the projdata from a file.

Succeeded	set_up (const shared_ptr< const ExamInfo > &exam_info_sptr, const shared_ptr< const ProjDataInfo > &) override
	initialises the object and checks if it can handle such projection data More...

float	get_uncalibrated_bin_efficiency (const Bin &bin) const override

bool	use_detector_efficiencies () const

bool	use_dead_time () const

bool	use_geometric_factors () const

bool	use_crystal_interference_factors () const

Public Member Functions inherited from stir::RegisteredParsingObject< BinNormalisationFromGEHDF5, BinNormalisation, BinNormalisationWithCalibration >
std::string	get_registered_name () const override
	Returns Derived::registered_name.

std::string	parameter_info () override
	Returns a string with all parameters and their values, in a form suitable for parsing again.

Public Member Functions inherited from stir::BinNormalisationWithCalibration
Succeeded	set_up (const shared_ptr< const ExamInfo > &exam_info_sptr, const shared_ptr< const ProjDataInfo > &) override
	initialises the object and checks if it can handle such projection data More...

float	get_calib_decay_branching_ratio_factor (const Bin &) const
	product of calibration factor etc

float	get_calibration_factor () const override

float	get_branching_ratio () const

void	set_calibration_factor (const float)

void	set_radionuclide (const Radionuclide &)

float	get_bin_efficiency (const Bin &bin) const final
	return efficiency for 1 bin More...

Public Member Functions inherited from stir::BinNormalisation
virtual bool	is_trivial () const
	check if we would be multiplying with 1 (i.e. do nothing) More...

virtual bool	is_TOF_only_norm () const
	returns if the object can only handle TOF data More...

virtual void	apply (RelatedViewgrams< float > &) const
	normalise some data More...

virtual void	undo (RelatedViewgrams< float > &) const
	undo the normalisation of some data More...

void	apply (ProjData &, shared_ptr< DataSymmetriesForViewSegmentNumbers >=shared_ptr< DataSymmetriesForViewSegmentNumbers >()) const
	normalise some data More...

void	undo (ProjData &, shared_ptr< DataSymmetriesForViewSegmentNumbers >=shared_ptr< DataSymmetriesForViewSegmentNumbers >()) const
	undo the normalisation of some data More...

void	set_exam_info_sptr (const shared_ptr< const ExamInfo > _exam_info_sptr)

shared_ptr< const ExamInfo >	get_exam_info_sptr () const

Public Member Functions inherited from stir::ParsingObject
	ParsingObject (const ParsingObject &)

ParsingObject &	operator= (const ParsingObject &)

void	ask_parameters ()

bool	parse (std::istream &f)

bool	parse (const char *const filename)

Static Public Attributes
static const char *const	registered_name = "From GE HDF5"
	Name which will be used when parsing a BinNormalisation object.

Additional Inherited Members
Static Public Member Functions inherited from stir::RegisteredParsingObject< BinNormalisationFromGEHDF5, BinNormalisation, BinNormalisationWithCalibration >
static BinNormalisation *	read_from_stream (std::istream *)
	Construct a new object (of type Derived) by parsing the istream. More...

Static Public Member Functions inherited from stir::RegisteredObject< BinNormalisation >
static BinNormalisation *	read_registered_object (std::istream *in, const std::string &registered_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 BinNormalisation *	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< BinNormalisation >
typedef BinNormalisation (	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::BinNormalisationWithCalibration
void	set_defaults () override

void	initialise_keymap () override
	Initialise all keywords.

bool	post_processing () override
	This will be called at the end of the parsing. More...

Protected Member Functions inherited from stir::BinNormalisation
virtual void	check (const ProjDataInfo &proj_data_info) const
	check if the argument is the same as what was used for set_up() More...

virtual void	check (const ExamInfo &exam_info) const

Protected Member Functions inherited from stir::ParsingObject
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< BinNormalisation >
static RegistryType &	registry ()
	Static function returning the registry. More...

Protected Attributes inherited from stir::BinNormalisation
bool	_already_set_up

shared_ptr< const ProjDataInfo >	proj_data_info_sptr

Protected Attributes inherited from stir::ParsingObject
KeyParser	parser

Detailed Description

A BinNormalisation class that gets the normalisation factors from an GEHDF5 3D normalisation file.

Parsing example

Bin Normalisation type := from GE HDF5
Bin Normalisation From GEHDF5:=
normalisation filename:= myfile.hn

; next keywords can be used to switch off some of the normalisation components
; do not use unless you know why
; use_detector_efficiencies:=1
; use_dead_time:=1
; use_geometric_factors:=1
; use_crystal_interference_factors:=1
End Bin Normalisation From GEHDF5:=

Todo:: dead-time is not yet implemented

Constructor & Destructor Documentation

◆ BinNormalisationFromGEHDF5()

stir::GE::RDF_HDF5::BinNormalisationFromGEHDF5::BinNormalisationFromGEHDF5 ( )

Default constructor.

Warning: You should not call any member functions for any object just constructed with this constructor. Initialise the object properly first by parsing.

Member Function Documentation

◆ set_up()

Succeeded stir::GE::RDF_HDF5::BinNormalisationFromGEHDF5::set_up	(	const shared_ptr< const ExamInfo > &	exam_info_sptr,
		const shared_ptr< const ProjDataInfo > &	proj_data_info_sptr_v
	)

overridevirtual

initialises the object and checks if it can handle such projection data

Default version sets _already_set_up and stores the shared pointers.

Reimplemented from stir::BinNormalisation.

References stir::VectorWithOffset< T >::begin(), stir::VectorWithOffset< T >::end(), stir::error(), and stir::warning().

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

/home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/recon_buildblock/BinNormalisationFromGEHDF5.h
/home/sirfuser/devel/STIRdistrib/STIR/src/recon_buildblock/BinNormalisationFromGEHDF5.cxx

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BinNormalisationFromGEHDF5()

Member Function Documentation

◆ set_up()