fiff_types.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef FIFF_TYPES_H
#define FIFF_TYPES_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_constants.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QList>
#include <QStringList>
#include <QPair>
#include <QVariant>
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
const static QStringList defaultQStringList = QStringList();
static Eigen::MatrixXd defaultMatrixXd = Eigen::MatrixXd::Constant(1,1,-1);
const static Eigen::MatrixXd defaultConstMatrixXd(0,0);
const static Eigen::MatrixXi defaultMatrixXi(0,0);
const static Eigen::VectorXi defaultVectorXi;
const static Eigen::RowVectorXi defaultRowVectorXi;
const static QPair<float,float> defaultFloatPair = qMakePair(-1.0f, -1.0f);
 
typedef Eigen::Matrix<qint16, Eigen::Dynamic, Eigen::Dynamic> MatrixDau16;
typedef Eigen::Matrix<short, Eigen::Dynamic, Eigen::Dynamic> MatrixShort;
 
//=============================================================================================================
// TYPEDEFS Primitive building blocks:
//=============================================================================================================
 
typedef unsigned char        fiff_byte_t;
typedef char                 fiff_char_t;
typedef qint16               fiff_short_t;
typedef quint16              fiff_ushort_t;
typedef qint32               fiff_int_t;
typedef quint32              fiff_uint_t;
typedef qint64               fiff_long_t;
typedef quint64              fiff_ulong_t;
typedef float                fiff_float_t;
typedef double               fiff_double_t;
typedef quint16              fiff_dau_pack13_t;
typedef quint16              fiff_dau_pack14_t;
typedef qint16               fiff_dau_pack16_t;
typedef qint32               fiff_julian_t;
typedef char                 fiff_data_t; //unsig char instead of void -> avoid void in C++ cause of its undefined behaviour using delete -> this can happen during lots of casting
 
//=============================================================================================================
// TYPEDEFS Structured types:
//=============================================================================================================
 
typedef struct _fiffTimeRec {
 fiff_int_t secs;           
 fiff_int_t usecs;          
} *fiffTime, fiffTimeRec;   
//typedef struct _fiffDigStringRec {
// fiff_int_t kind;       /**< Most commonly FIFF_POINT_EXTRA. */
// fiff_int_t ident;          /**< Number identifying this string. */
// fiff_int_t np;         /**< How many points. */
// fiff_float_t **rr;         /**< Array of point locations. */
//} fiffDigStringRec, *fiffDigString;/**< Structure representing digitized strings. */
 
//typedef fiffDigStringRec fiff_dig_string_t;
 
/*
 * The layered sphere model
 */
 
//typedef struct _fiffLayerRec {
// fiff_int_t   id;     /**< Id # of this layer (see below). */
// fiff_float_t rad;        /**< Radius of this layer (m). */
//} *fiffLayer, fiffLayerRec;      /**< Layer descriptor for a layered sphere model. */
 
//=============================================================================================================
// TYPEDEF Following types are used by the fiff library. They are not used within the files.:
//=============================================================================================================
 
//typedef struct _fiff_sparse_matrix {
// fiff_int_t   coding;          /**< coding (storage) type of the sparse matrix. */
// fiff_int_t   m;          /**< m rows. */
// fiff_int_t   n;               /**< n columns. */
// fiff_int_t   nz;              /**< nz nonzeros. */
// fiff_float_t *data;           /**< owns the data. */
// fiff_int_t   *inds;           /**< index list, points into data, no dealloc!. */
// fiff_int_t   *ptrs;           /**< pointer list, points into data, no dealloc!. */
//} *fiffSparseMatrix, fiffSparseMatrixRec;
 
//typedef fiffSparseMatrixRec  fiff_sparse_matrix_t;
 
//typedef struct _fiff_event_bits {
// fiff_int_t from_mask;         /**< from mask. */
// fiff_int_t from_state;        /**< from state. */
// fiff_int_t to_mask;           /**< to mask. */
// fiff_int_t to_state;          /**< to state. */
//} *fiffEventBits, fiffEventBitsRec;
 
//typedef struct _fiff_hpi_coil {
// char *event_channel;          /**< event channel. */
// fiffEventBitsRec event_bits;  /**< event bits. */
// char *signal_channel;         /**< signal channel. */
//} *fiffHpiCoil, fiffHpiCoilRec;
 
//typedef struct _fiff_hpi_subsys {
// fiff_int_t   ncoils;          /**< number of hpi coils. */
// fiffHpiCoil  coils;           /**< hpi coils. */
//} *fiffHpiSubsys, fiffHpiSubsysRec;
 
typedef struct _fiff_data_ref {
    fiff_int_t      type;       
    fiff_int_t      endian;     
    fiff_long_t     size;       
    fiff_long_t     offset;     
} *fiffDataRef,fiffDataRefRec;
 
//=============================================================================================================
//=============================================================================================================
 
 
typedef struct _fiffTagRec {
 fiff_int_t  kind;      
 fiff_int_t  type;      
 fiff_int_t  size;      
 fiff_int_t  next;      
 fiff_data_t *data;     
} *fiffTag,fiffTagRec;   
 
typedef struct _fiffIdRec {
 fiff_int_t version;       
 fiff_int_t machid[2];     
 fiffTimeRec time;     
} *fiffId,fiffIdRec;       
typedef fiffIdRec fiff_id_t;
 
 
typedef struct _fiffDirEntryRec {
 fiff_int_t  kind;      
 fiff_int_t  type;      
 fiff_int_t  size;      
 fiff_int_t  pos;       
} fiffDirEntryRec,*fiffDirEntry;
typedef fiffDirEntryRec fiff_dir_entry_t;
 
 
typedef struct _fiffDigPointRec {
 fiff_int_t kind;        
 fiff_int_t ident;       
 fiff_float_t r[3];      
} *fiffDigPoint,fiffDigPointRec; 
//typedef fiffDigPointRec  fiff_dig_point_t;
//typedef fiffDigStringRec fiff_dig_string_t;
 
 
/*----------------------------------------------------------------------
 * Following types are used by the fiff library. They are not used
 * within the files.
 *---------------------------------------------------------------------*/
 
//typedef struct _fiffDirNode {
// int                 type;     /**< Block type for this directory. */
// fiffId              id;        /**< Id of this block if any. */
// fiffDirEntry        dir;  /**< Directory of tags in this node. */
// int                 nent;     /**< Number of entries in this node. */
// fiffDirEntry        dir_tree;     /**< Directory of tags within this node
//                  * subtrees as well as FIFF_BLOCK_START and FIFF_BLOCK_END
//                  * included. NOTE: While dir is allocated separately
//                  * dir_tree is a pointer to the dirtree field
//                  * in the fiffFile structure. The dir_tree and nent_tree
//                  * fields are only used within the library to facilitate
//                  * certain operations. */
// int                 nent_tree; /**< Number of entries in the directory tree node. */
// struct _fiffDirNode *parent;  /**< Parent node. */
// struct _fiffDirNode **children;/**< Child nodes. */
// int                 nchild;   /**< Number of child nodes. */
//} fiffDirNodeRec,*fiffDirNode;     /**< Directory tree structure used by the fiff library routines. */
 
 
//typedef struct _fiffFileRec {
//  char         *file_name;    /**< Name of the file. */
//  FILE         *fd;       /**< The normal file descriptor. */
//  fiffId       id;        /**< The file identifier. */
//  fiffDirEntry dir;       /**< This is the directory.
//                 * If no directory exists, fiff_open
//                 * automatically scans the file to create one. */
//  int         nent;           /**< How many entries?. */
//  fiffDirNode dirtree;        /**< Directory compiled into a tree. */
//  char        *ext_file_name; /**< Name of the file holding the external data. */
//  FILE        *ext_fd;        /**< The file descriptor of the above file if open . */
//} *fiffFile,fiffFileRec;  /**< FIFF file handle. fiff_open() returns this. */
 
 
//typedef struct _fiffCoordTransRec {
// fiff_int_t   from;             /**< Source coordinate system. */
// fiff_int_t   to;           /**< Destination coordinate system. */
// fiff_float_t rot[3][3];        /**< The forward transform (rotation part). */
// fiff_float_t move[3];              /**< The forward transform (translation part). */
// fiff_float_t invrot[3][3];         /**< The inverse transform (rotation part). */
// fiff_float_t invmove[3];            /**< The inverse transform (translation part). */
//} *fiffCoordTrans, fiffCoordTransRec; /**< Coordinate transformation descriptor. */
 
//typedef fiffCoordTransRec fiff_coord_trans_t;
 
 
//typedef struct _fiffChPosRec {
//    fiff_int_t   coil_type;     /**< What kind of coil. */
//    fiff_float_t r0[3];         /**< Coil coordinate system origin. */
//    fiff_float_t ex[3];         /**< Coil coordinate system x-axis unit vector. */
//    fiff_float_t ey[3];         /**< Coil coordinate system y-axis unit vector. */
//    fiff_float_t ez[3];         /**< Coil coordinate system z-axis unit vector. */
//} fiffChPosRec,*fiffChPos;      /**< Measurement channel position and coil type. */
 
//typedef fiffChPosRec fiff_ch_pos_t;
 
 
//typedef struct _fiffChInfoRec {
//    fiff_int_t    scanNo;       /**< Scanning order number. */
//    fiff_int_t    logNo;        /**< Logical channel #. */
//    fiff_int_t    kind;         /**< Kind of channel. */
//    fiff_float_t  range;        /**< Voltmeter range (-1 = auto ranging). */
//    fiff_float_t  cal;          /**< Calibration from volts to units used. */
//    fiff_ch_pos_t chpos;        /**< Channel location. */
//    fiff_int_t    unit;         /**< Unit of measurement. */
//    fiff_int_t    unit_mul;     /**< Unit multiplier exponent. */
//    fiff_char_t   ch_name[16];  /**< Descriptive name for the channel. */
//} fiffChInfoRec,*fiffChInfo;    /**< Description of one channel. */
 
//typedef fiffChInfoRec fiff_ch_info_t;
 
#define FIFFM_CHPOS(x) &((x)->chpos)
 
}//NAMESPACE
 
#endif // FIFF_TYPES_H