fiff_proj.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_PROJ_H
#define FIFF_PROJ_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_global.h"
#include "fiff_types.h"
#include "fiff_named_matrix.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <QMap>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
class FiffRawData;
class FiffEvoked;
 
//=============================================================================================================
class FIFFSHARED_EXPORT FiffProj
{
public:
    using SPtr = QSharedPointer<FiffProj>;             
    using ConstSPtr = QSharedPointer<const FiffProj>;  
    using UPtr = std::unique_ptr<FiffProj>;            
    using ConstUPtr = std::unique_ptr<const FiffProj>; 
 
    //=========================================================================================================
    FiffProj();
 
    //=========================================================================================================
    FiffProj(const FiffProj& p_FiffProj);
 
    //=========================================================================================================
    FiffProj& operator=(const FiffProj& other) = default;
 
    //=========================================================================================================
    explicit FiffProj(fiff_int_t p_kind,
                      bool p_active,
                      QString p_desc,
                      FiffNamedMatrix& p_data);
 
    //=========================================================================================================
    ~FiffProj();
 
    //=========================================================================================================
    static void activate_projs(QList<FiffProj>& p_qListFiffProj);
 
    //=========================================================================================================
    static fiff_int_t make_projector(const QList<FiffProj>& projs,
                                     const QStringList& ch_names,
                                     Eigen::MatrixXd& proj,
                                     const QStringList& bads = defaultQStringList,
                                     Eigen::MatrixXd& U = defaultMatrixXd);
 
    //=========================================================================================================
    static QList<FiffProj> compute_from_raw(const FiffRawData& raw,
                                            const Eigen::MatrixXi& events,
                                            int eventCode,
                                            float tmin,
                                            float tmax,
                                            int nGrad,
                                            int nMag,
                                            int nEeg,
                                            const QMap<QString, double>& mapReject = QMap<QString, double>());
 
    //=========================================================================================================
    static QList<FiffProj> compute_from_evoked(const FiffEvoked& evoked, int nGrad = 2, int nMag = 2, int nEeg = 2);
 
    //=========================================================================================================
    friend std::ostream& operator<<(std::ostream& out, const FIFFLIB::FiffProj& p_FiffProj);
 
public:
    fiff_int_t kind; 
    bool active;     
    QString desc;    
 
    FiffNamedMatrix::SDPtr data; 
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline std::ostream& operator<<(std::ostream& out, const FIFFLIB::FiffProj& p_FiffProj)
{
    out << "#### Fiff Projector ####\n";
    out << "\tKind: " << p_FiffProj.kind << std::endl;
    out << "\tactive: " << p_FiffProj.active << std::endl;
    out << "\tdesc: " << p_FiffProj.desc.toUtf8().constData() << std::endl;
    out << "\tdata:\n\t" << *p_FiffProj.data.data() << std::endl;
    return out;
}
} // NAMESPACE
 
#endif // FIFF_PROJ_H