mne_sourcespace.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef MNE_SOURCESPACE_H
#define MNE_SOURCESPACE_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "mne_global.h"
#include "mne_hemisphere.h"

#include <fiff/fiff_types.h>
#include <fiff/fiff_dir_node.h>
#include <fiff/fiff.h>

#include <algorithm>
#include <vector>

//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================

#include <Eigen/Core>

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QList>

//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================

namespace FSLIB
{
    class Label;
}

//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================

namespace MNELIB
{

//=============================================================================================================
// MNELIB FORWARD DECLARATIONS
//=============================================================================================================

//=============================================================================================================
class MNESHARED_EXPORT MNESourceSpace
{
public:
    typedef QSharedPointer<MNESourceSpace> SPtr;            
    typedef QSharedPointer<const MNESourceSpace> ConstSPtr; 
    //=========================================================================================================
    MNESourceSpace();

    //=========================================================================================================
    MNESourceSpace(const MNESourceSpace &p_MNESourceSpace);

    //=========================================================================================================
    ~MNESourceSpace();

    //=========================================================================================================
    void clear();

    //=========================================================================================================
    inline bool isEmpty() const;

    //=========================================================================================================
    static qint32 find_source_space_hemi(MNEHemisphere& p_Hemisphere);

    //=========================================================================================================
    QList<Eigen::VectorXi> get_vertno() const;

    //=========================================================================================================
    QList<Eigen::VectorXi> label_src_vertno_sel(const FSLIB::Label &p_label, Eigen::VectorXi &src_sel) const;

    //=========================================================================================================
    static bool patch_info(MNEHemisphere &p_Hemisphere);//VectorXi& nearest, QList<VectorXi>& pinfo);@param[in] nearest   The nearest vector of the source space.@param[in, out] pinfo    The requested patch information.

    //=========================================================================================================
    MNESourceSpace pick_regions(const QList<FSLIB::Label> &p_qListLabels) const;

    //=========================================================================================================
    static bool readFromStream(FIFFLIB::FiffStream::SPtr& p_pStream,
                               bool add_geom,
                               MNESourceSpace& p_SourceSpace);

    //=========================================================================================================
    inline qint32 size() const;

    //=========================================================================================================
    bool transform_source_space_to(FIFFLIB::fiff_int_t dest,
                                   FIFFLIB::FiffCoordTrans& trans);

    //=========================================================================================================
    void writeToStream(FIFFLIB::FiffStream* p_pStream);

    //=========================================================================================================
    MNEHemisphere& operator[] (qint32 idx);

    //=========================================================================================================
    const MNEHemisphere& operator[] (qint32 idx) const;

    //=========================================================================================================
    MNEHemisphere& operator[] (QString idt);

    //=========================================================================================================
    const MNEHemisphere& operator[] (QString idt) const;

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

private:

    //=========================================================================================================
    static bool complete_source_space_info(MNEHemisphere& p_Hemisphere);

    //=========================================================================================================
    static bool read_source_space(FIFFLIB::FiffStream::SPtr& p_pStream,
                                  const FIFFLIB::FiffDirNode::SPtr& p_Tree,
                                  MNEHemisphere& p_Hemisphere);

private:
    QList<MNEHemisphere> m_qListHemispheres;    
};

//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================

inline bool MNESourceSpace::isEmpty() const
{
    return m_qListHemispheres.size() == 0;
}

//=============================================================================================================

inline qint32 MNESourceSpace::size() const
{
    return m_qListHemispheres.size();
}

//=============================================================================================================

inline bool operator== (const MNESourceSpace &a, const MNESourceSpace &b)
{
    return (a.m_qListHemispheres == b.m_qListHemispheres);
}
} // NAMESPACE

#endif // MNE_SOURCESPACE_H