DecayLinearization Class Reference

A decay modifier to apply linearization to a DecayCurve. More...

#include <DecayLinearization.h>

Inheritance diagram for DecayLinearization:

Collaboration diagram for DecayLinearization:

Public Member Functions
void	set_linearization_table (DecayCurve *v)
DecayCurve *	get_linearization_table ()
void	add (DecayCurve *out) override
	DecayLinearization (DecayCurve *linearization_table, int start, int stop, bool active=true, int n_window=5)
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 decay modifier to apply linearization to a DecayCurve.

The DecayLinearization class is a subclass of DecayModifier. It takes a DecayCurve as input and computes a linearization table for the input curve. The linearization table is then applied to the input DecayCurve using the add() method.

Typical applications of DecayLinearization include computing a perturbed fluorescence decay model.

Constructor & Destructor Documentation

DecayLinearization()

DecayLinearization::DecayLinearization	(	DecayCurve *	linearization_table,
		int	start,
		int	stop,
		bool	active = true,
		int	n_window = 5
	)

Construct a DecayLinearization object.

Parameters

linearization_table	The linearization table
start	The start index of the linearization window
stop	The stop index of the linearization window
active	Flag indicating if the DecayLinearization is active
n_window	The size of the linearization window

Member Function Documentation

add()

void DecayLinearization::add ( DecayCurve *  out )

overridevirtual

Apply the linearization table to the input DecayCurve.

Parameters

out	The output DecayCurve

Implements DecayModifier.

get_linearization_table()

DecayCurve * DecayLinearization::get_linearization_table

(

)

Get the linearization table of the DecayLinearization object.

Returns

The linearization table

set_linearization_table()

void DecayLinearization::set_linearization_table

(

DecayCurve *

v

)

Set the linearization table for the DecayLinearization object.

Parameters

v	The linearization table

---

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

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