mne_proj_op.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef MNEPROJOP_H
#define MNEPROJOP_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "mne_global.h"
#include "mne_named_matrix.h"
#include "mne_proj_item.h"
 
#include <fiff/fiff_types.h>
#include <fiff/fiff_stream.h>
#include <fiff/fiff_dir_node.h>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QTextStream>
 
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================
 
namespace MNELIB
{
 
class MNECovMatrix;
 
//=============================================================================================================
class MNESHARED_EXPORT MNEProjOp
{
public:
    typedef QSharedPointer<MNEProjOp> SPtr;              
    typedef QSharedPointer<const MNEProjOp> ConstSPtr;   
 
    //=========================================================================================================
    MNEProjOp();
 
    //=========================================================================================================
    ~MNEProjOp();
 
    //=========================================================================================================
    void free_proj();

    MNEProjOp* combine(MNEProjOp* from);

    void add_item_active(const MNENamedMatrix* vecs, int kind, const  QString& desc, bool is_active);

    void add_item(const MNENamedMatrix* vecs, int kind, const QString& desc);

    std::unique_ptr<MNEProjOp> dup() const;

    static std::unique_ptr<MNEProjOp> create_average_eeg_ref(const QList<FIFFLIB::FiffChInfo>& chs, int nch);

    int affect(const QStringList& list, int nlist);

    int affect_chs(const QList<FIFFLIB::FiffChInfo> &chs, int nch);

    int project_vector(Eigen::Ref<Eigen::VectorXf> vec, bool do_complement);

    static std::unique_ptr<MNEProjOp> read_from_node(FIFFLIB::FiffStream::SPtr& stream,
                                     const FIFFLIB::FiffDirNode::SPtr& start);

    static std::unique_ptr<MNEProjOp> read(const QString& name);

    static bool makeProjection(const QList<QString>& projnames,
                               const QList<FIFFLIB::FiffChInfo>& chs,
                               int nch,
                               std::unique_ptr<MNEProjOp>& result);

    void report_data(QTextStream &out, const QString &tag, bool list_data, const QStringList &exclude);

    void report(QTextStream &out, const QString &tag);
 
    //=========================================================================================================
    int assign_channels(const QStringList& list, int nlist);
 
    //=========================================================================================================
    int make_proj_bad(const QStringList& bad);
 
    //=========================================================================================================
    int make_proj();
 
    //=========================================================================================================
    int project_dvector(Eigen::Ref<Eigen::VectorXd> vec, bool do_complement);
 
    //=========================================================================================================
    int apply_cov(MNECovMatrix* c);
 
public:
    QList<MNELIB::MNEProjItem> items;  
    int         nitems;                 
    QStringList names;                  
    int         nch;                    
    int         nvec;                   
    Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor> proj_data; 
};
 
} // NAMESPACE MNELIB
 
#endif // MNEPROJOP_H