xdf.h

Go to the documentation of this file.

//libxdf is a static C++ library to load XDF files
//Copyright (C) 2017  Yida Lin

//This program is free software: you can redistribute it and/or modify
//it under the terms of the GNU General Public License as published by
//the Free Software Foundation, either version 3 of the License, or
//(at your option) any later version.

//This program is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.

//You should have received a copy of the GNU General Public License
//along with this program.  If not, see <http://www.gnu.org/licenses/>.
//If you have questions, contact author at ITAL_FAZIOLI@hotmail.com

#ifndef XDF_H
#define XDF_H

#include <string>
#include <vector>
#include <map>
#include <set>

class Xdf
{  
public:
    Xdf();

    //subclass for single streams
    struct Stream
    {
        std::vector<std::vector<float> > time_series;
        std::vector<float> time_stamps; 
        std::string streamHeader;   
        std::string streamFooter;   
        struct
        {
            int channel_count;      
            double nominal_srate;   
            std::string name;       
            std::string type;       
            std::string channel_format;
            std::vector<std::map<std::string, std::string> > channels;
            std::vector<std::pair<double, double> > clock_offsets;  
            double first_timestamp; 
            double last_timestamp;  
            int sample_count;       
            double measured_srate;  
            double effective_sample_rate;
        } info; 
        float last_timestamp{ 0 };  
        float sampling_interval;    
        std::vector<double> clock_times;
        std::vector<double> clock_values;
    };

    //XDF properties=================================================================================

    std::vector<Stream> streams; 
    float version;  
    uint64_t totalLen = 0;  
    float minTS = 0;        
    float maxTS = 0;        
    size_t totalCh = 0;     
    int majSR = 0;          
    int maxSR = 0;          
    std::vector<int> streamMap;
    typedef std::string eventName;
    typedef float eventTimeStamp;

    std::vector<std::pair<std::pair<eventName, eventTimeStamp>, int> > eventMap;
    std::vector<std::string> dictionary;
    std::vector<uint16_t> eventType;    
    std::vector<std::string> labels;    
    std::set<double> sampleRateMap;  
    std::vector<float> offsets;         
    std::string fileHeader;             
    int userAddedStream { 0 };            
    std::vector<std::pair<std::string, double> > userCreatedEvents;
    //Public Functions==============================================================================================

    void adjustTotalLength();

    void calcTotalLength(int sampleRate);

    void createLabels();

    void detrend();

    void freeUpTimeStamps();

    int load_xdf(std::string filename);

    void resample(int userSrate);

    int writeEventsToXDF(std::string file_path);

    //Private Functions: Not intended to be used by external programs======================================

private:

    void calcEffectiveSrate();

    void calcTotalChannel();

    void findMajSR();

    void findMinMax();

    void getHighestSampleRate();

    void loadDictionary();

    void loadSampleRateMap();

    uint64_t readLength(std::ifstream &file);
};

#endif // XDF_H