mne_process_description.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef MNE_PROCESS_DESCRIPTION_H
#define MNE_PROCESS_DESCRIPTION_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "mne_global.h"
 
#include <fiff/fiff_evoked_set.h>
 
#include <QString>
#include <QStringList>
#include <QVector>
#include <QList>
 
//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================
 
namespace MNELIB
{
 
// Import averaging types from FIFFLIB for backward compatibility
using FIFFLIB::RejectionParams;
using FIFFLIB::AverageCategory;
using FIFFLIB::AverageDescription;
 
//=============================================================================================================
struct MNESHARED_EXPORT CovDefinition {
    QVector<unsigned int> events;       
    unsigned int ignore    = 0;         
    float delay            = 0.0f;      
    float tmin             = -0.2f;     
    float tmax             = 0.0f;      
    float bmin             = 0.0f;      
    float bmax             = 0.0f;      
    bool  doBaseline       = false;     
};
 
//=============================================================================================================
struct MNESHARED_EXPORT CovDescription {
    QList<CovDefinition> defs;           
    RejectionParams      rej;            
    bool  removeSampleMean = true;       
    bool  fixSkew          = false;      
    QString filename;                    
    QString eventFile;                   
    QString logFile;                     
};
 
//=============================================================================================================
struct MNESHARED_EXPORT FilterSettings {
    bool  filterOn          = true;      
    int   filterSize        = 4096;      
    int   taperSize         = 2048;      
    float highpass          = 0.0f;      
    float highpassWidth     = 0.0f;      
    float lowpass           = 40.0f;     
    float lowpassWidth      = 5.0f;      
    float eogHighpass       = 0.0f;      
    float eogHighpassWidth  = 0.0f;      
    float eogLowpass        = 40.0f;     
    float eogLowpassWidth   = 5.0f;      
};
 
//=============================================================================================================
struct MNESHARED_EXPORT ProcessingSettings {
    // Working directory
    QString workingDir;
 
    // Input
    QStringList rawFiles;               
    QStringList eventFiles;             
    int  compensateTo      = -1;        
    bool allowMaxShield    = false;     
 
    // Filter
    FilterSettings filter;
 
    // Events output
    QStringList eventsOutFiles;         
    bool saveAllEvents     = false;     
    QString digTrigger;                 
    unsigned int digTriggerMask = 0;    
 
    // Projection
    QStringList projFiles;              
    int  projOn            = -1;        
    bool makeProj          = false;     
    int  projEvent         = -1;        
    float projTmin         = -1.0f;     
    float projTmax         = -1.0f;     
    int  projNGrad         = 5;         
    int  projNMag          = 8;         
    int  projNEeg          = 0;         
    float projGradReject   = 2000e-13f; 
    float projMagReject    = 3e-12f;    
    float projEegReject    = 50e-6f;    
    QString saveProjTag;                
    bool saveProjAugmented = false;     
 
    // Save
    QStringList saveFiles;              
    bool omitSubjectInfo   = false;     
    int  decimation        = 1;         
    long splitSize         = -1;        
 
    // Averaging
    QStringList aveFiles;               
    QString saveAveTag;                 
    QString grandAveFile;               
 
    // Covariance
    QStringList covFiles;               
    QString saveCovTag;                 
    QString grandCovFile;               
 
    // Misc
    bool saveHere          = false;     
};
 
} // namespace MNELIB
 
#endif // MNE_PROCESS_DESCRIPTION_H