IMP logo
IMP Reference Guide  develop.63b38c487d,2024/12/21
The Integrative Modeling Platform
IMP::bff::DecayLinearization Class Reference

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

#include <IMP/bff/DecayLinearization.h>

+ Inheritance diagram for IMP::bff::DecayLinearization:

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.

Definition at line 38 of file DecayLinearization.h.

Public Member Functions

 DecayLinearization (DecayCurve *linearization_table, int start, int stop, bool active=true, int n_window=5)
 
void add (DecayCurve *out) override
 
DecayCurveget_linearization_table ()
 
void set_linearization_table (DecayCurve *v)
 
- Public Member Functions inherited from IMP::bff::DecayModifier
 DecayModifier (DecayCurve *data=nullptr, int start=0, int stop=-1, bool active=true)
 
 ~DecayModifier ()
 
virtual DecayCurveget_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
DecayCurvedata = nullptr
 
DecayCurvedefault_data = nullptr
 

Constructor & Destructor Documentation

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

Construct a DecayLinearization object.

Parameters
linearization_tableThe linearization table
startThe start index of the linearization window
stopThe stop index of the linearization window
activeFlag indicating if the DecayLinearization is active
n_windowThe size of the linearization window

Member Function Documentation

void IMP::bff::DecayLinearization::add ( DecayCurve out)
overridevirtual

Apply the linearization table to the input DecayCurve.

Parameters
outThe output DecayCurve

Implements IMP::bff::DecayModifier.

DecayCurve* IMP::bff::DecayLinearization::get_linearization_table ( )

Get the linearization table of the DecayLinearization object.

Returns
The linearization table
void IMP::bff::DecayLinearization::set_linearization_table ( DecayCurve v)

Set the linearization table for the DecayLinearization object.

Parameters
vThe linearization table

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