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

//! # bvreader
//! 
//! This crate provides a basic reader for BrainVision Recorder Files `(.vhdr/.vmrk/.eeg)`
//!
//! `ONLY FOR HEADER VERSION 1.0`
//!
//! Does not include full list of options but is extendable.
//!
//! In order to keep it simple all types (FLOAT32, INT16, UINT16) convert to f32.
//!
//! Only implements processing for `Timedomain Data`.
//!
//! See the bv_reader module for usage instructions.
//!
//! 

/// ## Usage
/// ```
/// 
/// use crate::bvreader::bv_reader::BVFile;
/// 
/// let headerfile = "src/bv_reader/data/testfiles/01_header.vhdr";
/// let mut metafile = BVFile::from_header(headerfile).unwrap();
/// 
/// // Optionally validate the BVFile struct
/// metafile.validate().unwrap();
/// 
/// // metafile.bv_header       contains the struct with header information
/// // metafile.bv_data         contains the data, filepath and number of channels
/// // metafile.bv_marker       contains the marker events
/// 
/// // scale data according to the resolution
/// metafile.bv_data.scale_channels(&metafile.bv_header.channel_info).unwrap();
/// 
/// ```
pub mod bv_reader;