tttr-toolbox-arrays 0.5.0

Fast streaming algorithms for your TTTR data.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

use crate::errors::Error;
use crate::headers::File;
use crate::array_stream::ArrayStream;

pub mod g2_asymmetric;
pub mod g2_symmetric;

#[derive(Debug, Copy, Clone)]
pub enum G2Mode {
    Asymmetric,
    Symmetric,
}

/// Result from the g2 algorithm
pub struct G2Result {
    pub t: Vec<f64>,
    pub hist: Vec<u64>,
}

/// Parameters for the g2 algorithm
///
/// # Parameters
///    - channel_1: The number of the first input channel into the TCSPC
///    - channel_2: The number of the second input channel into the TCSPC
///    - correlation_window: Length of the correlation window of interest in seconds
///    - resolution: Resolution of the g2 histogram in seconds
#[derive(Debug, Clone)]
pub struct G2Params {
    pub channel_1: i32,
    pub channel_2: i32,
    pub correlation_window: f64,
    pub resolution: f64,
    pub record_ranges: Option<Vec<(usize, usize)>>,
}

pub fn g2(f: &File, params: &G2Params, mode: G2Mode) -> Result<G2Result, Error> {
    match mode {
        G2Mode::Symmetric => g2_symmetric::g2(f, params),
        G2Mode::Asymmetric => g2_asymmetric::g2(f, params),
    }
}

pub fn g2_from_arrays(
    timestamps_ps: &[u64],
    channels: &[i32],
    params: &G2Params,
    mode: G2Mode,
) -> Result<G2Result, Error> 
{

    // ---------------------------------------------------------
    // No record selection:
    // analyse the entire stream.
    // ---------------------------------------------------------

    if params.record_ranges.is_none() {

        let stream = ArrayStream::new(
            timestamps_ps,
            channels,
            None,
            None,
        )?;

        let result = match mode {
            G2Mode::Symmetric => {
                g2_symmetric::g2_from_stream(
                    stream,
                    params,
                    1e-12,
                )
            }

            G2Mode::Asymmetric => {
                g2_asymmetric::g2_from_stream(
                    stream,
                    params,
                    1e-12,
                )
            }
        };

        return Ok(result);
    }


    // ---------------------------------------------------------
    // Record-range selection
    // ---------------------------------------------------------

    let ranges = params
        .record_ranges
        .as_ref()
        .unwrap();

    let mut total_result: Option<G2Result> = None;

    for &(start_record, stop_record) in ranges {

        let stream = ArrayStream::new(
            timestamps_ps,
            channels,
            Some(start_record),
            Some(stop_record),
        )?;

        let result = match mode {
            G2Mode::Symmetric => {
                g2_symmetric::g2_from_stream(
                    stream,
                    params,
                    1e-12,
                )
            }

            G2Mode::Asymmetric => {
                g2_asymmetric::g2_from_stream(
                    stream,
                    params,
                    1e-12,
                )
            }
        };

        if let Some(total) = total_result.as_mut() {

            for (dst, src) in
                total.hist.iter_mut().zip(result.hist.iter())
            {
                *dst += *src;
            }

        } else {
            total_result = Some(result);
        }
    }


    // Empty range list: return an empty histogram of the
    // correct dimensions.
    if let Some(result) = total_result {
        Ok(result)
    } else {

        let stream = ArrayStream::new(
            timestamps_ps,
            channels,
            Some(0),
            Some(0),
        )?;

        Ok(match mode {
            G2Mode::Symmetric => {
                g2_symmetric::g2_from_stream(
                    stream,
                    params,
                    1e-12,
                )
            }

            G2Mode::Asymmetric => {
                g2_asymmetric::g2_from_stream(
                    stream,
                    params,
                    1e-12,
                )
            }
        })
    }
}