DecayPileup Class Reference

A decorator that adds pile-up effects to a DecayCurve object. More...

#include <DecayPileup.h>

Inheritance diagram for DecayPileup:

Collaboration diagram for DecayPileup:

Public Member Functions
void	set_pile_up_model (std::string v)
	Set the pile-up model.
std::string	get_pile_up_model ()
	Get the pile-up model.
void	set_repetition_rate (double v)
	Set the repetition rate.
double	get_repetition_rate ()
	Get the repetition rate.
void	set_instrument_dead_time (double v)
	Set the instrument dead time.
double	get_instrument_dead_time ()
	Get the instrument dead time.
void	add (DecayCurve *out) override
	Add pile-up effects to the DecayCurve object.
	DecayPileup (DecayCurve *data, const char *pile_up_model="coates", double repetition_rate=100, double instrument_dead_time=120, int start=0, int stop=-1, bool active=true)
	Constructor for DecayPileup.
Public Member Functions inherited from DecayModifier
virtual void	set_data (DecayCurve *v)
virtual DecayCurve *	get_data ()
bool	is_active () const
void	set_active (bool v)
void	set (DecayCurve *data, int start=0, int stop=-1, bool active=true)
void	resize (size_t n, double v=0.0)
	DecayModifier (DecayCurve *data=nullptr, int start=0, int stop=-1, bool active=true)
	~DecayModifier ()
Public Member Functions inherited from DecayRange
void	set_start (int v)
	Set the start index of the decay range.
size_t	get_start (DecayCurve *d=nullptr) const
	Get the start index of the decay range.
void	set_stop (int v)
	Set the stop index of the decay range.
size_t	get_stop (DecayCurve *d=nullptr) const
	Get the stop index of the decay range.
void	set_range (std::vector< int > v)
	Set the range using a vector of indices.
std::vector< int >	get_range (DecayCurve *d=nullptr)
	Get the range as a vector of indices.
void	set (int start=0, int stop=-1)
	Set the start and stop indices of the decay range.
	DecayRange (int start, int stop)
	Constructor.
virtual	~DecayRange ()=default
	Destructor.

Additional Inherited Members
Protected Attributes inherited from DecayModifier
DecayCurve *	data = nullptr
DecayCurve *	default_data = nullptr

Detailed Description

A decorator that adds pile-up effects to a DecayCurve object.

DecayPileup is a subclass of DecayModifier and provides methods to set and get the pile-up model, repetition rate, and instrument dead time. It also overrides the add() method to add pile-up effects to the DecayCurve object.

Constructor & Destructor Documentation

DecayPileup()

DecayPileup::DecayPileup	(	DecayCurve *	data,
		const char *	pile_up_model = "coates",
		double	repetition_rate = 100,
		double	instrument_dead_time = 120,
		int	start = 0,
		int	stop = -1,
		bool	active = true
	)

Constructor for DecayPileup.

Parameters

data	The DecayCurve object to decorate.
pile_up_model	The pile-up model identifier.
repetition_rate	The repetition rate in MHz.
instrument_dead_time	The instrument dead time in units of the lifetime.
start	The start index of the DecayCurve.
stop	The stop index of the DecayCurve.
active	The activity status of the DecayPileup object.

Member Function Documentation

add()

void DecayPileup::add ( DecayCurve *  out )

overridevirtual

Add pile-up effects to the DecayCurve object.

Parameters

out	The DecayCurve object to add pile-up effects to.

Implements DecayModifier.

get_instrument_dead_time()

double DecayPileup::get_instrument_dead_time

(

)

Get the instrument dead time.

Returns

The instrument dead time in units of the lifetime.

get_pile_up_model()

std::string DecayPileup::get_pile_up_model

(

)

Get the pile-up model.

Returns

The pile-up model identifier.

get_repetition_rate()

double DecayPileup::get_repetition_rate

(

)

Get the repetition rate.

Returns

The repetition rate in MHz.

set_instrument_dead_time()

void DecayPileup::set_instrument_dead_time

(

double

v

)

Set the instrument dead time.

Parameters

v	The instrument dead time in units of the lifetime.

set_pile_up_model()

void DecayPileup::set_pile_up_model

(

std::string

v

)

Set the pile-up model.

Parameters

v	The pile-up model identifier.

set_repetition_rate()

void DecayPileup::set_repetition_rate

(

double

v

)

Set the repetition rate.

Parameters

v	The repetition rate in MHz.

---

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

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