fiff_info_base.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_INFO_BASE_H
#define FIFF_INFO_BASE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_global.h"
#include "fiff_types.h"
#include "fiff_id.h"
#include "fiff_ch_info.h"
#include "fiff_dig_point.h"
#include "fiff_ctf_comp.h"
#include "fiff_coord_trans.h"
#include "fiff_proj.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QList>
#include <QMap>
#include <QStringList>
#include <QSharedPointer>
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
//=============================================================================================================
class FIFFSHARED_EXPORT FiffInfoBase
{
public:
    using SPtr = QSharedPointer<FiffInfoBase>;             
    using ConstSPtr = QSharedPointer<const FiffInfoBase>;  
    using UPtr = std::unique_ptr<FiffInfoBase>;            
    using ConstUPtr = std::unique_ptr<const FiffInfoBase>; 
 
    //=========================================================================================================
    FiffInfoBase();
 
    //=========================================================================================================
    FiffInfoBase(const FiffInfoBase& p_FiffInfoBase);
 
    //=========================================================================================================
    FiffInfoBase& operator=(const FiffInfoBase& other) = default;
 
    //=========================================================================================================
    virtual ~FiffInfoBase();
 
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    QString channel_type(qint32 idx) const;
 
    //=========================================================================================================
    QMap<QString, QList<int>> channel_indices_by_type(const QList<int>& picks = {}) const;
 
    //=========================================================================================================
    static Eigen::RowVectorXi pick_channels_regexp(const QStringList& ch_names, const QString& regexp);
 
    //=========================================================================================================
    inline bool isEmpty() const;
 
    //=========================================================================================================
    static Eigen::RowVectorXi pick_channels(const QStringList& ch_names,
                                            const QStringList& include = defaultQStringList,
                                            const QStringList& exclude = defaultQStringList);
 
    //=========================================================================================================
    FiffInfoBase pick_info(const Eigen::RowVectorXi* sel = nullptr) const;
 
    //=========================================================================================================
    Eigen::RowVectorXi pick_types(const QString meg,
                                  bool eeg = false,
                                  bool stim = false,
                                  const QStringList& include = defaultQStringList,
                                  const QStringList& exclude = defaultQStringList) const;
 
    //=========================================================================================================
    Eigen::RowVectorXi pick_types(bool meg,
                                  bool eeg = false,
                                  bool stim = false,
                                  const QStringList& include = defaultQStringList,
                                  const QStringList& exclude = defaultQStringList) const;

    friend bool operator==(const FiffInfoBase& a, const FiffInfoBase& b);

    void mne_read_meg_comp_eeg_ch_info(QList<FiffChInfo>& megp,
                                       int& nmegp,
                                       QList<FiffChInfo>& meg_compp,
                                       int& nmeg_compp,
                                       QList<FiffChInfo>& eegp,
                                       int& neegp,
                                       FiffCoordTrans& meg_head_t,
                                       FiffId& idp) const;

    QStringList get_channel_types();
 
    //=========================================================================================================
    static bool readBadChannelsFromFile(const QString& name, QStringList& listOut);
 
public:
    QString filename;                      
    QStringList bads;                      
    FiffId meas_id;                        
    fiff_int_t nchan;                      
    QList<FiffChInfo> chs;                 
    QStringList ch_names;                  
    FiffCoordTrans dev_head_t;             
    FiffCoordTrans ctf_head_t;             
    QList<FiffCoordTrans> all_coord_trans; 
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline bool FiffInfoBase::isEmpty() const
{
    return this->nchan <= 0;
}
 
//=============================================================================================================
 
inline bool operator==(const FiffInfoBase& a, const FiffInfoBase& b)
{
    return (a.bads == b.bads &&
            //a.meas_id == b.meas_id &&
            a.nchan == b.nchan &&
            a.chs == b.chs &&
            a.ch_names == b.ch_names &&
            a.dev_head_t == b.dev_head_t &&
            a.ctf_head_t == b.ctf_head_t);
}
} // NAMESPACE
 
#endif // FIFF_INFO_BASE_H