IMP::bff::DecayPileup Class Reference

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

#include <IMP/bff/DecayPileup.h>

Inheritance diagram for IMP::bff::DecayPileup:

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.

Definition at line 34 of file DecayPileup.h.

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

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

Constructor & Destructor Documentation

IMP::bff::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

void IMP::bff::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 IMP::bff::DecayModifier.

double IMP::bff::DecayPileup::get_instrument_dead_time

(

)

Get the instrument dead time.

Returns

The instrument dead time in units of the lifetime.

std::string IMP::bff::DecayPileup::get_pile_up_model

(

)

Get the pile-up model.

Returns

The pile-up model identifier.

double IMP::bff::DecayPileup::get_repetition_rate

(

)

Get the repetition rate.

Returns

The repetition rate in MHz.

void IMP::bff::DecayPileup::set_instrument_dead_time

(

double

v

)

Set the instrument dead time.

Parameters

v	The instrument dead time in units of the lifetime.

void IMP::bff::DecayPileup::set_pile_up_model

(

std::string

v

)

Set the pile-up model.

Parameters

v	The pile-up model identifier.

void IMP::bff::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:

• DecayPileup.h