IMP.bff
Loading...
Searching...
No Matches
Public Member Functions | List of all members
DecayRange Class Reference

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

#include <DecayRange.h>

Inheritance diagram for DecayRange:
Inheritance graph
Collaboration diagram for DecayRange:
Collaboration graph

Public Member Functions

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.
 

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.

Constructor & Destructor Documentation

◆ DecayRange()

DecayRange::DecayRange ( int  start,
int  stop 
)

Constructor.

Parameters
startThe start index of the decay range
stopThe stop index of the decay range

◆ ~DecayRange()

virtual DecayRange::~DecayRange ( )
virtualdefault

Destructor.

Member Function Documentation

◆ get_range()

std::vector< int > DecayRange::get_range ( DecayCurve d = nullptr)

Get the range as a vector of indices.

Parameters
dThe DecayCurve object (optional)
Returns
The vector of indices

◆ get_start()

size_t DecayRange::get_start ( DecayCurve d = nullptr) const

Get the start index of the decay range.

Parameters
dThe DecayCurve object (optional)
Returns
The start index

◆ get_stop()

size_t DecayRange::get_stop ( DecayCurve d = nullptr) const

Get the stop index of the decay range.

Parameters
dThe DecayCurve object (optional)
Returns
The stop index

◆ set()

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

Set the start and stop indices of the decay range.

Parameters
startThe start index (default: 0)
stopThe stop index (default: -1)

◆ set_range()

void DecayRange::set_range ( std::vector< int >  v)

Set the range using a vector of indices.

Parameters
vThe vector of indices

◆ set_start()

void DecayRange::set_start ( int  v)

Set the start index of the decay range.

Parameters
vThe start index

◆ set_stop()

void DecayRange::set_stop ( int  v)

Set the stop index of the decay range.

Parameters
vThe stop index

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