IMP::bff::DecayPattern Class Reference

The DecayPattern class represents a decay pattern with a constant offset and a background pattern. More...

#include <IMP/bff/DecayPattern.h>

Inheritance diagram for IMP::bff::DecayPattern:

Detailed Description

The DecayPattern class represents a decay pattern with a constant offset and a background pattern.

The DecayPattern class is a subclass of DecayModifier and provides functionality to add a background pattern to a decay curve. It allows setting and retrieving the constant offset and the fraction of the background pattern.

Definition at line 26 of file DecayPattern.h.

Public Member Functions
	DecayPattern (double constant_offset=0.0, DecayCurve *pattern=nullptr, double pattern_fraction=0.0, int start=0, int stop=-1, bool active=true)
	Constructor for the DecayPattern class. More...
void	add (DecayCurve *out) override
	Add the background pattern to the given decay curve. More...
double	get_constant_offset () const
	Get the constant offset in the model. More...
DecayCurve *	get_pattern ()
	Get the background pattern. More...
double	get_pattern_fraction () const
	Get the fraction (area) of the background pattern. More...
void	set_constant_offset (double v)
	Set the constant offset in the model. More...
void	set_pattern (DecayCurve *v)
	Set the background pattern. More...
void	set_pattern_fraction (double v)
	Set the fraction (area) of the background pattern. 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::DecayPattern::DecayPattern ( double  constant_offset = 0.0, DecayCurve *  pattern = nullptr, double  pattern_fraction = 0.0, int  start = 0, int  stop = -1, bool  active = true  )

explicit

Constructor for the DecayPattern class.

Parameters

constant_offset	The constant offset in the model (default: 0.0).
pattern	The background pattern (default: nullptr).
pattern_fraction	The fraction (area) of the background pattern (default: 0.0).
start	The start index of the decay curve (default: 0).
stop	The stop index of the decay curve (default: -1).
active	The flag indicating if the DecayPattern is active (default: true).

Member Function Documentation

void IMP::bff::DecayPattern::add ( DecayCurve *  out )

overridevirtual

Add the background pattern to the given decay curve.

Parameters

out	The decay curve to add the background pattern to.

Implements IMP::bff::DecayModifier.

double IMP::bff::DecayPattern::get_constant_offset

(

)

const

Get the constant offset in the model.

Returns

The constant offset in the model.

DecayCurve* IMP::bff::DecayPattern::get_pattern

(

)

Get the background pattern.

Returns

The background pattern.

double IMP::bff::DecayPattern::get_pattern_fraction

(

)

const

Get the fraction (area) of the background pattern.

Returns

The fraction (area) of the background pattern.

void IMP::bff::DecayPattern::set_constant_offset

(

double

v

)

Set the constant offset in the model.

Parameters

v	The constant offset to set.

void IMP::bff::DecayPattern::set_pattern

(

DecayCurve *

v

)

Set the background pattern.

Parameters

v	The background pattern to set.

void IMP::bff::DecayPattern::set_pattern_fraction

(

double

v

)

Set the fraction (area) of the background pattern.

Parameters

v	The fraction (area) of the background pattern to set.

---

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

• DecayPattern.h