DecayPhasor Class Reference

Utility class for computing phasor values in decay analysis. More...

#include <DecayPhasor.h>

Static Public Member Functions
static std::vector< double >	compute_phasor (unsigned short *microtimes, int n_microtimes, double frequency=1.0, int minimum_number_of_photons=1, double g_irf=1.0, double s_irf=0.0, std::vector< int > *idxs=nullptr)
	Compute the phasor (g, s) for a selection of microtimes.
static std::vector< double >	compute_phasor_bincounts (std::vector< int > &bincounts, double frequency, int minimum_number_of_photons, double g_irf, double s_irf)
	Compute the phasor (g, s) for a histogram/bincounts of microtimes.
static double	g (double g_irf, double s_irf, double g_exp, double s_exp)
	Calculate g-value for a given set of phasor parameters.
static double	s (double g_irf, double s_irf, double g_exp, double s_exp)
	Calculate s-value for a given set of phasor parameters.

Detailed Description

Utility class for computing phasor values in decay analysis.

Member Function Documentation

compute_phasor()

static std::vector< double > DecayPhasor::compute_phasor ( unsigned short * microtimes, int n_microtimes, double frequency = 1.0, int minimum_number_of_photons = 1, double g_irf = 1.0, double s_irf = 0.0, std::vector< int > * idxs = nullptr )

static

Compute the phasor (g, s) for a selection of microtimes.

This function computes the phasor (g, s) for a set of microtimes that are selected using a second vector of indices. The indices specify which elements of the microtimes vector are used to compute the phasor.

Parameters

[in]	microtimes	Vector of microtimes.
[in]	n_microtimes	Number of elements in the microtimes vector.
[in]	frequency	The frequency of the phasor.
[in]	minimum_number_of_photons	Minimum number of photons.
[in]	g_irf	G-value of instrument response phasor.
[in]	s_irf	S-value of instrument response phasor.
[in]	idxs	Vector of selected indices.

Returns

Vector of length 2: first element g-value, second element s-value.

compute_phasor_bincounts()

static std::vector< double > DecayPhasor::compute_phasor_bincounts ( std::vector< int > & bincounts, double frequency, int minimum_number_of_photons, double g_irf, double s_irf )

static

Compute the phasor (g, s) for a histogram/bincounts of microtimes.

This function computes the phasor (g, s) for bincounted microtimes.

Parameters

[in]	bincounts	Vector of bincounts.
[in]	frequency	The frequency of the phasor.
[in]	minimum_number_of_photons	Minimum number of photons.
[in]	g_irf	G-value of instrument response phasor.
[in]	s_irf	S-value of instrument response phasor.

Returns

Vector of length 2: first element g-value, second element s-value.

g()

static double DecayPhasor::g ( double g_irf, double s_irf, double g_exp, double s_exp )

static

Calculate g-value for a given set of phasor parameters.

Reference: https://journals.plos.org/plosone/article/file?type=supplementary&id=info:doi/10.1371/journal.pone.0194578.s001

Parameters

[in]	g_irf	G-value of instrument response phasor.
[in]	s_irf	S-value of instrument response phasor.
[in]	g_exp	Experimental g-value.
[in]	s_exp	Experimental s-value.

Returns

Computed g-value.

s()

static double DecayPhasor::s ( double g_irf, double s_irf, double g_exp, double s_exp )

static

Calculate s-value for a given set of phasor parameters.

Reference: https://journals.plos.org/plosone/article/file?type=supplementary&id=info:doi/10.1371/journal.pone.0194578.s001

Parameters

[in]	g_irf	G-value of instrument response phasor.
[in]	s_irf	S-value of instrument response phasor.
[in]	g_exp	Experimental g-value.
[in]	s_exp	Experimental s-value.

Returns

Computed s-value.

---

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

• /builds/skf/tttrlib/include/DecayPhasor.h