IMP::bff::DecayRange Class Reference

Represents an inspected range of fluorescence decay. More...

#include <IMP/bff/DecayRange.h>

Inheritance diagram for IMP::bff::DecayRange:

Detailed Description

Represents an inspected range of fluorescence decay.

The DecayRange class represents an inspected range of fluorescence decay. It allows setting and retrieving the start and stop indices of the range, as well as setting the range using a vector of indices.

Definition at line 33 of file DecayRange.h.

Public Member Functions
	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

Constructor & Destructor Documentation

IMP::bff::DecayRange::DecayRange	(	int	start,
		int	stop
	)

Constructor.

Parameters

start	The start index of the decay range
stop	The stop index of the decay range

virtual IMP::bff::DecayRange::~DecayRange ( )

virtualdefault

Destructor.

Member Function Documentation

std::vector<int> IMP::bff::DecayRange::get_range

(

DecayCurve *

d = nullptr

)

Get the range as a vector of indices.

Parameters

d	The DecayCurve object (optional)

Returns

The vector of indices

size_t IMP::bff::DecayRange::get_start

(

DecayCurve *

d = nullptr

)

const

Get the start index of the decay range.

Parameters

d	The DecayCurve object (optional)

Returns

The start index

size_t IMP::bff::DecayRange::get_stop

(

DecayCurve *

d = nullptr

)

const

Get the stop index of the decay range.

Parameters

d	The DecayCurve object (optional)

Returns

The stop index

void IMP::bff::DecayRange::set	(	int	start = 0,
		int	stop = -1
	)

Set the start and stop indices of the decay range.

Parameters

start	The start index (default: 0)
stop	The stop index (default: -1)

void IMP::bff::DecayRange::set_range

(

std::vector< int >

v

)

Set the range using a vector of indices.

Parameters

v	The vector of indices

void IMP::bff::DecayRange::set_start

(

int

v

)

Set the start index of the decay range.

Parameters

v	The start index

void IMP::bff::DecayRange::set_stop

(

int

v

)

Set the stop index of the decay range.

Parameters

v	The stop index

---

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

• DecayRange.h