Trivial class which does not do any normalisation whatsoever. More...

#include "stir/recon_buildblock/TrivialBinNormalisation.h"

Inheritance diagram for stir::TrivialBinNormalisation:

[legend]

Public Member Functions
void	apply (RelatedViewgrams< float > &) const override
	normalise some data More...

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

float	get_bin_efficiency (const Bin &bin) const override
	Return the 'efficiency' factor for a single bin. More...

bool	is_trivial () const override
	check if we would be multiplying with 1 (i.e. do nothing) More...

Public Member Functions inherited from stir::RegisteredParsingObject< TrivialBinNormalisation, BinNormalisation >
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::BinNormalisation
virtual float	get_calibration_factor () const

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

virtual Succeeded	set_up (const shared_ptr< const ExamInfo > &exam_info_sptr, const shared_ptr< const ProjDataInfo > &)
	initialises the object and checks if it can handle such projection 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 = "None"
	Name which will be used when parsing a BinNormalisation object.

Additional Inherited Members
Static Public Member Functions inherited from stir::RegisteredParsingObject< TrivialBinNormalisation, BinNormalisation >
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::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 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< 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

Trivial class which does not do any normalisation whatsoever.

Todo:: Make sure that the keyword value None corresponds to this class.

Member Function Documentation

◆ apply()

void stir::TrivialBinNormalisation::apply ( RelatedViewgrams< float > & viewgrams ) const

inlineoverridevirtual

normalise some data

This would be used for instance to precorrect unnormalised data. With the notation of the class documentation, this would divide by the factors $\mathrm{norm}_b$ .

Default implementation divides with the factors returned by get_bin_efficiency() (after applying a threshold to avoid division by 0).

Reimplemented from stir::BinNormalisation.

◆ undo()

void stir::TrivialBinNormalisation::undo ( RelatedViewgrams< float > & viewgrams ) const

inlineoverridevirtual

undo the normalisation of some data

This would be used for instance to bring geometrically forward projected data to the mean of the measured data. With the notation of the class documentation, this would multiply by the factors $\mathrm{norm}_b$ .

Default implementation multiplies with the factors returned by get_bin_efficiency().

Reimplemented from stir::BinNormalisation.

◆ get_bin_efficiency()

float stir::TrivialBinNormalisation::get_bin_efficiency ( const Bin & bin ) const

inlineoverridevirtual

Return the 'efficiency' factor for a single bin.

With the notation of the class documentation, this returns the factor $\mathrm{norm}_b$ .

Warning: Some derived classes might implement this very inefficiently.

Implements stir::BinNormalisation.

◆ is_trivial()

bool stir::TrivialBinNormalisation::is_trivial ( ) const

inlineoverridevirtual

check if we would be multiplying with 1 (i.e. do nothing)

This function can be used to check if the operations are guaranteed to do nothing (while potentially taking time and effort). The base-class sets this to always return false. It is up to the derived class to change this.

Reimplemented from stir::BinNormalisation.

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply()

◆ undo()

◆ get_bin_efficiency()

◆ is_trivial()