bvreader 0.1.5

Reader for the BrainVision data format
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

pub mod data;

pub mod header;

pub mod marker;

pub mod bv_error;

pub mod generic_parser;

pub mod validator;

use header::BVheader;
use marker::BVMarker;
use data::BVData;
use bv_error::Error;

use validator::{IsValid, validate_num_chan, parse_invalid_to_error};

/// Main struct of the file reader
/// 
/// Combines Header, Marker and Data
/// 
///  
#[derive(Debug, PartialEq)]
pub struct BVFile {
    pub bv_header: BVheader,
    pub bv_marker: BVMarker,
    pub bv_data: BVData,
}


impl BVFile {
    /// Main function for the file reader
    /// 
    /// Takes the header filename and returns the fully parsed struct or an error if anything went wrong
    pub fn from_header(headerfile: &str) -> Result<Self, Error> {

        let root_path: Vec<&str> = headerfile.split("/").collect();
        let root_path = &root_path[0..root_path.len()-1];


        let bv_header = BVheader::from_file(headerfile)?;
        let marker_path = format!("{}/{}",root_path.join("/"),&bv_header.marker_file);
        let bv_marker = BVMarker::from_file(&marker_path)?;

        let data_path = format!("{}/{}",root_path.join("/"),&bv_header.data_file);
        let bv_data = BVData::from_file(&data_path, bv_header.num_channels, bv_header.binary_format ,bv_header.data_orientation, bv_header.use_big_endian)?;

        Ok(BVFile{
            bv_header,
            bv_marker,
            bv_data,
        })
    }

    /// Sequential validation of file parameters
    /// 
    /// Includes:
    /// 
    /// - number of channels
    /// 
    pub fn validate(&self) -> Result<(), Error> {

        let valid = validate_num_chan(&self);
        if valid != IsValid::True {return Err(parse_invalid_to_error(&valid));}
        
        Ok(())
    }

}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_bv_file() {
        let input = "src/bv_reader/data/testfiles/01_header.vhdr";
        let output = BVFile::from_header(input).unwrap();
        let expected: usize = 71;
        //println!("{:?}", output);
        assert_eq!(output.bv_header.num_channels, expected);
    }

    #[test]
    fn test_parse_bv_file_empty() {
        let input = "";
        let output = BVFile::from_header(input);
        assert_eq!(output.is_err(), true);
    }

    #[test]
    fn test_validate_valid() {
        let input = "src/bv_reader/data/testfiles/01_header.vhdr";
        let output = BVFile::from_header(input).unwrap().validate();
        let expected: Result<(), Error> = Ok(());
        //println!("{:?}", output);
        assert_eq!(output, expected);
    }

}