Detailed Description

A decorator that modifies a DecayCurve within a specified range.

The DecayModifier class is a decorator that modifies a DecayCurve object within a specified range. It is used to apply modifications to the decay behavior of a DecayCurve. The modifications are applied by the add method, which modifies the input DecayCurve object.

Definition at line 29 of file DecayModifier.h.

Public Member Functions
	DecayModifier (DecayCurve *data=nullptr, int start=0, int stop=-1, bool active=true)

	~DecayModifier ()

virtual void	add (DecayCurve *out)=0

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

Protected Attributes
DecayCurve *	data = nullptr

DecayCurve *	default_data = nullptr

Constructor & Destructor Documentation

IMP::bff::DecayModifier::DecayModifier	(	DecayCurve *	data = `nullptr`,
		int	start = `0`,
		int	stop = `-1`,
		bool	active = `true`
	)

Construct a DecayModifier object.

Parameters

data	The DecayCurve object to be modified.
start	The start of the DecayModifier.
stop	The stop of the DecayModifier.
active	If true, the DecayModifier is active.

IMP::bff::DecayModifier::~DecayModifier ( )

Destructor.

Definition at line 98 of file DecayModifier.h.

Member Function Documentation

virtual void IMP::bff::DecayModifier::add ( DecayCurve * out )

pure virtual

Modify the DecayCurve object.

Parameters

out	The DecayCurve object to be modified.

Implemented in IMP::bff::DecayConvolution, IMP::bff::DecayScale, IMP::bff::DecayPileup, IMP::bff::DecayPattern, and IMP::bff::DecayLinearization.

virtual DecayCurve* IMP::bff::DecayModifier::get_data ( )

virtual

Get the DecayCurve object being modified.

Returns: The DecayCurve object being modified.

bool IMP::bff::DecayModifier::is_active ( ) const

Check if the DecayModifier is active.

Returns: True if the DecayModifier is active, false otherwise.

void IMP::bff::DecayModifier::resize	(	size_t	n,
		double	v = `0.0`
	)

Resize the data of the DecayModifier.

Parameters

n	The new size of the data.
v	The value of the data (if larger than the original size).

void IMP::bff::DecayModifier::set	(	DecayCurve *	data,
		int	start = `0`,
		int	stop = `-1`,
		bool	active = `true`
	)

Set the values of the DecayModifier.

Parameters

data	The DecayModifier data.
start	The start of the DecayModifier.
stop	The stop of the DecayModifier.
active	If true, the DecayModifier modifies the input decay.

void IMP::bff::DecayModifier::set_active ( bool v )

Set the activity status of the DecayModifier.

Parameters

v	The activity status of the DecayModifier.

virtual void IMP::bff::DecayModifier::set_data ( DecayCurve * v )

virtual

Set the DecayCurve object to be modified.

Parameters

v	The DecayCurve object to be modified.

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

DecayModifier.h

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation