DecayLifetimeHandler Class Reference

#include <DecayLifetimeHandler.h>

Collaboration diagram for DecayLifetimeHandler:

Public Member Functions
double	get_amplitude_threshold ()
void	set_amplitude_threshold (double v)
bool	get_use_amplitude_threshold ()
void	set_use_amplitude_threshold (bool v)
bool	get_abs_lifetime_spectrum () const
void	set_abs_lifetime_spectrum (bool v)
void	set_lifetime_spectrum (std::vector< double > v)
void	add_lifetime (double amplitude, double lifetime)
std::vector< double > &	get_lifetime_spectrum ()
void	get_lifetime_spectrum (double **output_view, int *n_output)
	DecayLifetimeHandler (std::vector< double > lifetime_spectrum=std::vector< double >(), bool use_amplitude_threshold=false, bool abs_lifetime_spectrum=false, double amplitude_threshold=std::numeric_limits< double >::epsilon())

Constructor & Destructor Documentation

DecayLifetimeHandler()

DecayLifetimeHandler::DecayLifetimeHandler	(	std::vector< double >	lifetime_spectrum = std::vector< double >(),
		bool	use_amplitude_threshold = false,
		bool	abs_lifetime_spectrum = false,
		double	amplitude_threshold = std::numeric_limits< double >::epsilon()
	)

Construct a DecayLifetimeHandler object.

Parameters

lifetime_spectrum	The initial lifetime spectrum (default: empty).
use_amplitude_threshold	Whether to use the amplitude threshold (default: false).
abs_lifetime_spectrum	Whether to use the absolute values of the lifetime spectrum (default: false).
amplitude_threshold	The amplitude threshold (default: epsilon).

Member Function Documentation

add_lifetime()

void DecayLifetimeHandler::add_lifetime	(	double	amplitude,
		double	lifetime
	)

Add a lifetime to the lifetime spectrum.

Parameters

amplitude	The amplitude of the lifetime.
lifetime	The lifetime value.

get_abs_lifetime_spectrum()

bool DecayLifetimeHandler::get_abs_lifetime_spectrum

(

)

const

Check if the absolute values of the lifetime spectrum are being used to compute the model function.

Returns

True if the absolute values are being used, false otherwise.

get_amplitude_threshold()

double DecayLifetimeHandler::get_amplitude_threshold

(

)

Get the amplitude threshold used to discriminate lifetimes with small amplitudes.

Returns

The amplitude threshold.

get_lifetime_spectrum() [1/2]

std::vector< double > & DecayLifetimeHandler::get_lifetime_spectrum

(

)

Get a reference to the lifetime spectrum.

Returns

A reference to the lifetime spectrum.

get_lifetime_spectrum() [2/2]

void DecayLifetimeHandler::get_lifetime_spectrum	(	double **	output_view,
		int *	n_output
	)

Get a view of the lifetime spectrum.

Parameters

output_view	A pointer to the output view of the lifetime spectrum.
n_output	A pointer to the number of elements in the output view.

get_use_amplitude_threshold()

bool DecayLifetimeHandler::get_use_amplitude_threshold

(

)

Check if the amplitude threshold is being used to discriminate lifetimes with small amplitudes.

Returns

True if the amplitude threshold is being used, false otherwise.

set_abs_lifetime_spectrum()

void DecayLifetimeHandler::set_abs_lifetime_spectrum

(

bool

v

)

Set whether to use the absolute values of the lifetime spectrum to compute the model function.

Parameters

v	True to use the absolute values, false otherwise.

set_amplitude_threshold()

void DecayLifetimeHandler::set_amplitude_threshold

(

double

v

)

Set the amplitude threshold used to discriminate lifetimes with small amplitudes.

Parameters

v	The amplitude threshold.

set_lifetime_spectrum()

void DecayLifetimeHandler::set_lifetime_spectrum

(

std::vector< double >

v

)

Set the lifetime spectrum.

Parameters

v	The lifetime spectrum to set.

set_use_amplitude_threshold()

void DecayLifetimeHandler::set_use_amplitude_threshold

(

bool

v

)

Set whether to use the amplitude threshold to discriminate lifetimes with small amplitudes.

Parameters

v	True to use the amplitude threshold, false otherwise.

---

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

• /Users/tpeulen/dev/imp.bff/include/DecayLifetimeHandler.h