mne_raw_data.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef MNERAWDATA_H
#define MNERAWDATA_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "../mne_global.h"

#include <fiff/fiff_dir_node.h>
#include <fiff/fiff_stream.h>
#include "mne_raw_info.h"
#include "mne_raw_buf_def.h"
#include "mne_proj_op.h"
#include "mne_sss_data.h"
#include "mne_ctf_comp_data_set.h"
#include "mne_deriv.h"
#include "mne_types.h"

//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================

#include <Eigen/Core>

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QSharedPointer>
#include <QList>

//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================

namespace MNELIB
{

//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================

//=============================================================================================================
class MNESHARED_EXPORT MneRawData
{
public:
    typedef QSharedPointer<MneRawData> SPtr;              
    typedef QSharedPointer<const MneRawData> ConstSPtr;   
    //=========================================================================================================
    MneRawData();

    //=========================================================================================================
    ~MneRawData();

    static void mne_raw_add_filter_response(MneRawData* data, int *highpass_effective);

    static void setup_filter_bufs(MneRawData* data);

    static int load_one_buffer(MneRawData* data, MneRawBufDef* buf);

    static int compensate_buffer(MneRawData* data, MneRawBufDef* buf);

    static int mne_raw_pick_data(MneRawData*    data,
                          mneChSelection sel,
                          int            firsts,
                          int            ns,
                          float          **picked);

    static int mne_raw_pick_data_proj(MneRawData*    data,
                               mneChSelection sel,
                               int            firsts,
                               int            ns,
                               float          **picked);

    static int load_one_filt_buf(MneRawData* data, MneRawBufDef* buf);

    static int mne_raw_pick_data_filt(MneRawData*    data,
                               mneChSelection sel,
                               int            firsts,
                               int            ns,
                               float          **picked);

    static MneRawData* mne_raw_open_file_comp(const QString& name, int omit_skip, int allow_maxshield, mneFilterDef filter, int comp_set);

    static MneRawData* mne_raw_open_file(const QString& name, int omit_skip, int allow_maxshield, mneFilterDef filter);

public:
    QString         filename;             /* This is our file */
    //  FIFFLIB::fiffFile       file;
    FIFFLIB::FiffStream::SPtr stream;
    MNELIB::MneRawInfo*      info;      /* Loaded using the mne routines */
    QStringList     ch_names;           /* Useful to have the channel names as a single list */
    QStringList     badlist;            /* Bad channel names */
    int             nbad;               /* How many? */
    int              *bad;              /* Which channels are bad? */
    MNELIB::MneRawBufDef* bufs;         /* These are the data */
    int              nbuf;                  /* How many? */
    MNELIB::MneRawBufDef* filt_bufs;    /* These are the filtered ones */
    int             nfilt_buf;
    int             first_samp;         /* First sample? */
    int             omit_samp;          /* How many samples of skip omitted in the beginning */
    int             first_samp_old;     /* This is the value first_samp would have in the old versions */
    int             omit_samp_old;      /* This is the value omit_samp would have in the old versions */
    int             nsamp;              /* How many samples in total? */
    float           *first_sample_val;  /* Values at the first sample (for dc offset correction before filtering) */
    MNELIB::MneProjOp* proj;            /* Projection operator */
    MNELIB::MneSssData* sss;            /* SSS data found in this file */
    MNELIB::MneCTFCompDataSet* comp;    /* Compensation data */
    int             comp_file;          /* Compensation status of these raw data in file */
    int             comp_now;           /* Compensation status of these raw data in file */
    mneFilterDef    filter;             /* Filter definition */
    void            *filter_data;       /* This can be whatever the filter needs */
    mneUserFreeFunc filter_data_free;   /* Function to free the above */
    mneEventList    event_list;         /* Trigger events */
    unsigned int    max_event;          /* Maximum event number in usenest */
    QString         dig_trigger;        /* Name of the digital trigger channel */
    unsigned int     dig_trigger_mask;  /* Mask applied to digital trigger channel before considering it */
    float            *offsets;          /* Dc offset corrections for display */
    void             *ring;             /* The ringbuffer (structure is of no interest to us) */
    void             *filt_ring;        /* Separate ring buffer for filtered data */
    MNELIB::MneDerivSet*  deriv;        /* Derivation data */
    MNELIB::MneDeriv*     deriv_matched;/* Derivation data matched to this raw data and collected into a single item */
    float            *deriv_offsets;        /* Dc offset corrections for display of the derived channels */
    void             *user;         /* Whatever */
    mneUserFreeFunc  user_free;     /* How this is freed */

//typedef struct {        /* A comprehensive raw data structure */
//    char             *filename;             /* This is our file */
//    //  FIFFLIB::fiffFile       file;
//    FIFFLIB::FiffStream::SPtr stream;
//    MNELIB::MneRawInfo*      info;      /* Loaded using the mne routines */
//    char             **ch_names;            /* Useful to have the channel names as a single list */
//    char             **badlist;             /* Bad channel names */
//    int              nbad;                  /* How many? */
//    int              *bad;                  /* Which channels are bad? */
//    MNELIB::MneRawBufDef* bufs;         /* These are the data */
//    int              nbuf;                  /* How many? */
//    MNELIB::MneRawBufDef* filt_bufs;    /* These are the filtered ones */
//    int              nfilt_buf;
//    int              first_samp;            /* First sample? */
//    int              omit_samp;             /* How many samples of skip omitted in the beginning */
//    int              first_samp_old;        /* This is the value first_samp would have in the old versions */
//    int              omit_samp_old;         /* This is the value omit_samp would have in the old versions */
//    int              nsamp;                 /* How many samples in total? */
//    float            *first_sample_val;     /* Values at the first sample (for dc offset correction before filtering) */
//    MNELIB::MneProjOp* proj;            /* Projection operator */
//    MNELIB::MneSssData* sss;            /* SSS data found in this file */
//    MNELIB::MneCTFCompDataSet* comp;    /* Compensation data */
//    int              comp_file;             /* Compensation status of these raw data in file */
//    int              comp_now;              /* Compensation status of these raw data in file */
//    mneFilterDef     filter;                /* Filter definition */
//    void             *filter_data;          /* This can be whatever the filter needs */
//    mneUserFreeFunc  filter_data_free;      /* Function to free the above */
//    mneEventList     event_list;            /* Trigger events */
//    unsigned int     max_event;             /* Maximum event number in usenest */
//    char             *dig_trigger;          /* Name of the digital trigger channel */
//    unsigned int     dig_trigger_mask;      /* Mask applied to digital trigger channel before considering it */
//    float            *offsets;              /* Dc offset corrections for display */
//    void             *ring;                 /* The ringbuffer (structure is of no interest to us) */
//    void             *filt_ring;            /* Separate ring buffer for filtered data */
//    MNELIB::MneDerivSet*  deriv;        /* Derivation data */
//    MNELIB::MneDeriv*     deriv_matched;/* Derivation data matched to this raw data and collected into a single item */
//    float            *deriv_offsets;        /* Dc offset corrections for display of the derived channels */
//    void             *user;           /* Whatever */
//    mneUserFreeFunc  user_free;     /* How this is freed */
//} *mneRawData,mneRawDataRec;
};

//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE MNELIB

#endif // MNERAWDATA_H