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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
use std::{fs::File, io::BufReader, path::Path};

use anyhow::{Context, Result};
use byteorder::{BigEndian, ByteOrder, LittleEndian, ReadBytesExt};
use nalgebra::Vector3;

use crate::{
    cheader::Endianness,
    tractogram::{Point, Points, Streamlines, Tractogram, TractogramItem},
    Affine, ArraySequence, Header, Spacing, Translation, Writer,
};

pub struct Reader {
    reader: BufReader<File>,
    endianness: Endianness,
    pub header: Header,

    raw: bool,
    voxel_space: Option<Spacing>,

    floats_per_point: usize,
    buffer: Vec<f32>,
}

impl Reader {
    /// Create an object to read all points of a TrackVis file in world space.
    ///
    /// Will also read the scalars and properties, if requested.
    pub fn new<P: AsRef<Path>>(path: P) -> Result<Reader> {
        let f = File::open(path.as_ref())
            .with_context(|| format!("Failed to load {:?}", path.as_ref()))?;
        let mut reader = BufReader::new(f);
        let (header, endianness) = Header::read(&mut reader)?;
        let floats_per_point = 3 + header.scalars_name.len();
        let buffer = Vec::with_capacity(300);

        let raw = false;
        let voxel_space = None;

        Ok(Reader { reader, endianness, header, raw, voxel_space, floats_per_point, buffer })
    }

    /// Modify the affine in order to read all streamlines in voxel space.
    ///
    /// Once this function is called, it's not possible to revert to reading in world space.
    ///
    /// Panics if `raw` has been called.
    pub fn to_voxel_space(mut self, spacing: Spacing) -> Self {
        if self.raw {
            panic!("Can't use raw + voxel space reading");
        }

        self.voxel_space = Some(spacing);
        self.header.affine_to_rasmm =
            Affine::from_diagonal(&Vector3::new(1.0 / spacing.x, 1.0 / spacing.y, 1.0 / spacing.z));
        self.header.translation = Translation::zeros();
        self
    }

    /// Read the points as they are written on disk, without any transformation.
    ///
    /// Panics if `to_voxel_space` has been called.
    pub fn raw(mut self) -> Self {
        if self.voxel_space.is_some() {
            panic!("Can't use voxel space + raw reading");
        }

        self.raw = true;
        self
    }

    /// Build a compatible `Writer` from the collected information in `self`.
    pub fn build_writer<P: AsRef<Path>>(&self, path: P) -> Result<Writer> {
        let mut w = Writer::new(path, Some(&self.header))?;
        if let Some(spacing) = self.voxel_space {
            w = w.from_voxel_space(spacing);
        } else if self.raw {
            w = w.raw();
        }
        Ok(w)
    }

    /// Iterate only on streamlines (`Vec<Point>`), ignoring scalars and properties.
    pub fn into_streamlines_iter(self) -> StreamlinesIter {
        StreamlinesIter { reader: self }
    }

    /// Read the complete tractogram, that is, all points, scalars and properties, if any.
    pub fn tractogram(&mut self) -> Tractogram {
        match self.endianness {
            Endianness::Little => self.read_tractogram_::<LittleEndian>(),
            Endianness::Big => self.read_tractogram_::<BigEndian>(),
        }
    }

    /// Read all points, ignoring the scalars and properties.
    pub fn streamlines(&mut self) -> Streamlines {
        match self.endianness {
            Endianness::Little => self.read_points_::<LittleEndian>(),
            Endianness::Big => self.read_points_::<BigEndian>(),
        }
    }

    fn read_tractogram_<E: ByteOrder>(&mut self) -> Tractogram {
        // TODO Anything we can do to reserve?
        let mut lengths = Vec::new();
        let mut v = Vec::with_capacity(300);
        let mut scalars = ArraySequence::with_capacity(300);
        let mut properties = ArraySequence::with_capacity(300);
        while let Ok(nb_points) = self.reader.read_i32::<E>() {
            lengths.push(nb_points as usize);
            self.read_streamline::<E>(&mut v, &mut scalars, nb_points as usize);
            self.read_properties_to_arr::<E>(&mut properties);
        }

        self.buffer = vec![];
        Tractogram::new(Streamlines::new(lengths, v), scalars, properties)
    }

    fn read_points_<E: ByteOrder>(&mut self) -> Streamlines {
        // TODO Anything we can do to reserve?
        let mut lengths = Vec::new();
        let mut v = Vec::with_capacity(300);
        while let Ok(nb_points) = self.reader.read_i32::<E>() {
            lengths.push(nb_points as usize);
            self.read_streamline_fast::<E>(&mut v, nb_points as usize);
        }

        self.buffer = vec![];
        Streamlines::new(lengths, v)
    }

    fn read_streamline<E: ByteOrder>(
        &mut self,
        points: &mut Points,
        scalars: &mut ArraySequence<f32>,
        nb_points: usize,
    ) {
        self.read_floats::<E>(nb_points);
        for floats in self.buffer.chunks(self.floats_per_point) {
            self.add_points(points, floats);
            for f in &floats[3..] {
                scalars.push(*f);
            }
        }
        scalars.end_push();
    }

    /// Ignore the scalars and properties.
    fn read_streamline_fast<E: ByteOrder>(&mut self, points: &mut Points, nb_points: usize) {
        self.read_floats::<E>(nb_points);
        for floats in self.buffer.chunks(self.floats_per_point) {
            self.add_points(points, floats);
            // Scalars have been read in `floats`, but we do not save them
        }

        // Properties must be read to advance the cursor, but we do not save them
        for _ in 0..self.header.properties_name.len() {
            self.reader.read_f32::<E>().unwrap();
        }
    }

    /// Read all points and scalars for the current streamline.
    ///
    /// Simply chunk the result by `nb_floats_per_point` to get the 3D point and the scalars.
    fn read_floats<E: ByteOrder>(&mut self, nb_points: usize) {
        // Vec::resize never decreases capacity, it can only increase it so there won't be any
        // useless allocation.
        let nb_floats = nb_points * self.floats_per_point;
        self.buffer.resize(nb_floats, 0.0);
        self.reader.read_f32_into::<E>(self.buffer.as_mut_slice()).unwrap();
    }

    #[inline(always)]
    fn add_points(&self, points: &mut Points, floats: &[f32]) {
        let mut p = Point::new(floats[0], floats[1], floats[2]);
        if !self.raw {
            p = (self.header.affine_to_rasmm * p) + self.header.translation;
        }
        points.push(p);
    }

    fn read_properties_to_arr<E: ByteOrder>(&mut self, properties: &mut ArraySequence<f32>) {
        for _ in 0..self.header.properties_name.len() {
            properties.push(self.reader.read_f32::<E>().unwrap());
        }
        properties.end_push();
    }

    fn read_properties_to_vec<E: ByteOrder>(&mut self, properties: &mut Vec<f32>) {
        for _ in 0..self.header.properties_name.len() {
            properties.push(self.reader.read_f32::<E>().unwrap());
        }
    }

    fn read_nb_points(&mut self) -> Option<usize> {
        match self.endianness {
            Endianness::Little => self.reader.read_i32::<LittleEndian>(),
            Endianness::Big => self.reader.read_i32::<BigEndian>(),
        }
        .ok()
        .map(|nb_points| nb_points as usize)
    }
}

impl Iterator for Reader {
    type Item = TractogramItem;

    fn next(&mut self) -> Option<TractogramItem> {
        let nb_points = self.read_nb_points()?;
        let mut streamline = Vec::with_capacity(nb_points);
        let mut scalars = ArraySequence::with_capacity(nb_points * self.header.scalars_name.len());
        let mut properties = Vec::with_capacity(self.header.properties_name.len());
        match self.endianness {
            Endianness::Little => {
                self.read_streamline::<LittleEndian>(&mut streamline, &mut scalars, nb_points);
                self.read_properties_to_vec::<LittleEndian>(&mut properties);
            }
            Endianness::Big => {
                self.read_streamline::<BigEndian>(&mut streamline, &mut scalars, nb_points);
                self.read_properties_to_vec::<BigEndian>(&mut properties);
            }
        };
        Some((streamline, scalars, properties))
    }
}

pub struct StreamlinesIter {
    reader: Reader,
}

impl Iterator for StreamlinesIter {
    type Item = Points;

    fn next(&mut self) -> Option<Points> {
        let nb_points = self.reader.read_nb_points()?;
        let mut streamline = Vec::with_capacity(nb_points);
        match self.reader.endianness {
            Endianness::Little => {
                self.reader.read_streamline_fast::<LittleEndian>(&mut streamline, nb_points);
            }
            Endianness::Big => {
                self.reader.read_streamline_fast::<BigEndian>(&mut streamline, nb_points);
            }
        };
        Some(streamline)
    }
}