Function tttr_toolbox::tttr_tools::g3::g3[][src]

pub fn g3(f: &File, params: &G3Params) -> Result<G3Result, Error>
Expand description

Computes the second order autocorrelation (g3) between two channels on a TCSPC module. $tau_1$ and $tau_2$ are measured relative to the channel we designate as channel 1.

Parameters

The parameters to the algorithm are passed via a G3Params struct that contains the following:

  • channel_1: The number of the first input channel into the TCSPC,
  • channel_2: The number of the second input channel into the TCSPC,
  • channel_3: The number of the third input channel into the TCSPC,
  • correlation_window: Length of the correlation window of interest in seconds,
  • resolution: Resolution of the g3 histogram in seconds,

Return

A square matrix with the (center_idx, center_idx) index being the (t1=0, t2=0) delays grow down and to the right. First index is tau1 and second index is tau2.

g^3: Third Order Coincidences

The g3 algorithm is a generalization of the g2 algorithm to third order coincidences. This tra

third order click orderings

Past clicks on each channel are pushed into circular buffers that keep the last N photons that arrived at each of them. A circular buffer allows to always have time ordered arrival times if we look from the head position of the buffer backwards.

Finite buffer artifacts

As with the g2 algorithm, the size of the buffers to store past clicks will determine the importance and the point at which artifacts appear on the histogram. The same consideration apply. See the second order autocorrelation documentation.