rust_abf 0.4.4

Rust crate for reading data from Axon Binary Format (ABF) files.
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

#[cfg(test)]
mod tests {
    use std::{time::Instant, path::Path};
    use rust_abf::{self, AbfKind, Abf};

    #[test]
    fn test_abfv2_1(){
        let start_time = Instant::now();
        let abf = Abf::from_file(Path::new("tests/test_abf/14o08011_ic_pair.abf")).unwrap();
        let _elapsed_time = start_time.elapsed();
        // println!("{:?}", elapsed_time);
        assert!(matches!(abf.get_file_signature(), AbfKind::AbfV2));
        let ch_num = abf.get_channels_count();
        for ch in 0..ch_num {
            let data = abf.get_sweep_in_channel(0, ch).unwrap();
            assert_eq!(&data.len(), &600_000);
            assert_eq!(abf.get_channel(ch).and_then(|ch| Some(ch.get_uom())), Some("mV"));
            assert_eq!(&data.len(), &600_000);
        }
        // assert!(elapsed_time.as_millis()<100);
    }

    #[test]
    fn test_access_abf_by_channel(){
        let start_time = Instant::now();
        let abf = Abf::from_file(Path::new("tests/test_abf/14o08011_ic_pair.abf")).unwrap();
        let _elapsed_time = start_time.elapsed();
        let ch0 = abf.get_channel(0).unwrap();
        // println!("{:?}", elapsed_time);
        assert!(matches!(ch0.get_label(), "IN 0"));
        assert!(matches!(ch0.get_uom(), "mV"));
        assert!(matches!(abf.get_sweeps_count() , 3));
        for s in 0..abf.get_sweeps_count() {
            assert_eq!(
                ch0.get_sweep(s).and_then(|ch| Some(ch.len())), 
                Some(600_000)
            );
        }
    }

    #[test]
    fn test_abfv2_2(){
        let start_time = Instant::now();
        let abf = Abf::from_file(Path::new("tests/test_abf/18425108.abf")).unwrap();
        let elapsed_time = start_time.elapsed();
        println!("{:?}", elapsed_time);
        assert!(matches!(abf.get_file_signature(), AbfKind::AbfV2));
        let ch_num = abf.get_channels_count();
        for ch in 0..ch_num {
            let data = abf.get_sweep_in_channel(0, ch).unwrap();
            assert_eq!(&data.len(), &250000);
            let ch = abf.get_channel(ch).unwrap();
            println!("Channel {:?} has as uom {:?}", ch.get_label(), ch.get_uom() );
        }
        assert!(matches!(abf.get_file_signature(), AbfKind::AbfV2));
    }

    #[test]
    fn iterate_over_sweep_and_channel(){
        let start_time = Instant::now();
        let abf = Abf::from_file(Path::new("tests/test_abf/18425108.abf")).unwrap();
        let elapsed_time = start_time.elapsed();
        println!("{:?}", elapsed_time);
        assert!(matches!(abf.get_file_signature(), AbfKind::AbfV2));
        let ch_num = abf.get_channels_count();
        let sw_num = abf.get_sweeps_count();
        assert_eq!(ch_num, 2);
        assert_eq!(sw_num, 1);
        (0..ch_num).for_each(|ch| {
            (0..sw_num).for_each(|s|{
                let data = abf.get_sweep_in_channel( s, ch).unwrap();
                assert_eq!(data.len(), 250_000)
            });
        });
    }
    
    #[test]
    fn test_iterator_over_channels(){
        let abf = Abf::from_file(Path::new("tests/test_abf/18425108.abf")).unwrap();
        abf.get_channels()
        .for_each(|c| assert_eq!(c.get_sweep(0).unwrap().len(), 250_000));
    }

    #[test]
    fn test_iterator_over_channels_and_sweeps(){
        let abf = Abf::from_file(Path::new("tests/test_abf/18425108.abf")).unwrap();
        abf.get_channels()
        .map(|c| c.get_sweeps())
        .flatten()
        .for_each(|s| assert_eq!(s.unwrap().len(), 250_000) );
    }

    #[test]
    fn test_get_path(){
        let path = Path::new("tests/test_abf/18425108.abf");
        let abf = Abf::from_file(&path).unwrap();
        assert_eq!(abf.get_path(), path);
    }

    #[test]
    #[ignore = "This test uses a very large file that is not versioned, and would break the ci"]
    fn test_abfv2_heavy(){
        let start_time = Instant::now();
        let abf = Abf::from_file(Path::new("C:\\Users\\lucar\\Desktop\\file_CH001_000.abf")).unwrap();
        let elapsed_time = start_time.elapsed();
        println!("{:?}", elapsed_time);
        assert_eq!(abf.get_sweeps_count(), 1);
        assert_eq!(abf.get_channels_count(), 2);
        assert_eq!(abf.get_channel(0).unwrap().get_label(), "I0");
        assert_eq!(abf.get_channel(0).unwrap().get_uom(), "nA");
        assert_eq!(abf.get_channel(1).unwrap().get_label(), "V0");
        assert_eq!(abf.get_channel(1).unwrap().get_uom(), "mV");
        // assert!(elapsed_time.as_millis()<900);
    }

    #[test]
    fn test_sampling_rate() {
        let abf = Abf::from_file(Path::new("tests/test_abf/18425108.abf")).unwrap();
        let sr = abf.get_sampling_rate();
        assert_eq!(sr, 25000.0);
    }
    // #[test]
    // fn test_abfv1(){
    //     let start_time = Instant::now();
    //     let abf = Abf::new("tests/test_abf/05210017_vc_abf1.abf");
    //     println!("{:?}", start_time.elapsed());
    //     assert!(matches!(abf.file_signature, AbfType::AbfV1));
    //     assert_eq!(abf.actual_episodes, 10);
    //     assert_eq!(abf.file_info_size, 4236247045);
    //     assert_eq!(abf.file_start_date, 6);
    //     assert_eq!(abf.file_start_time_ms, 20050210);
    //     assert_eq!(abf.file_type, 11985);
    // }
}