mne_source_space.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef MNESOURCESPACE_H
#define MNESOURCESPACE_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "mne_global.h"
#include "mne_surface_or_volume.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// STL INCLUDES
//=============================================================================================================
 
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================
 
namespace MNELIB
{
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
class MNEHemisphere;
 
//=============================================================================================================
class MNESHARED_EXPORT MNESourceSpace : public MNESurfaceOrVolume
{
public:
    using SPtr = std::shared_ptr<MNESourceSpace>;            
    using ConstSPtr = std::shared_ptr<const MNESourceSpace>; 
    using UPtr = std::unique_ptr<MNESourceSpace>;            
 
    //=========================================================================================================
    MNESourceSpace(int np = 0);
 
    //=========================================================================================================
    ~MNESourceSpace() override;
 
    //=========================================================================================================
    virtual MNESourceSpace::SPtr clone() const;
 
    //=========================================================================================================
    void enable_all_sources();
 
    //=========================================================================================================
    bool is_left_hemi() const;
 
    //=========================================================================================================
    qint32 find_source_space_hemi() const;
 
    //=========================================================================================================
    void update_inuse(Eigen::VectorXi new_inuse);
 
    //=========================================================================================================
    int transform_source_space(const FIFFLIB::FiffCoordTrans& t);
 
    //=========================================================================================================
    int add_patch_stats();
 
    //=========================================================================================================
    void rearrange_source_space();
 
    //=========================================================================================================
    static std::unique_ptr<MNESourceSpace> create_source_space(int np);
 
    //=========================================================================================================
    static std::unique_ptr<MNESourceSpace> load_surface(const QString& surf_file,
                                                        const QString& curv_file);
 
    //=========================================================================================================
    static std::unique_ptr<MNESourceSpace> load_surface_geom(const QString& surf_file,
                                                             const QString& curv_file,
                                                             bool add_geometry,
                                                             bool check_too_many_neighbors);
 
    //=========================================================================================================
    static MNESourceSpace* make_volume_source_space(const MNESurface& surf,
                                                    float grid,
                                                    float exclude,
                                                    float mindist);
 
    //=========================================================================================================
    // Source-space filtering, I/O, and label helpers (moved from MNESurfaceOrVolume)
    //=========================================================================================================
 
    static int filter_source_spaces(const MNESurface& surf,
                                    float limit,
                                    const FIFFLIB::FiffCoordTrans& mri_head_t,
                                    std::vector<std::unique_ptr<MNESourceSpace>>& spaces,
                                    QTextStream* filtered);
 
    static void filter_source_space(FilterThreadArg* arg);
 
    static int filter_source_spaces(float limit,
                                    const QString& bemfile,
                                    const FIFFLIB::FiffCoordTrans& mri_head_t,
                                    std::vector<std::unique_ptr<MNESourceSpace>>& spaces,
                                    QTextStream* filtered,
                                    bool use_threads);
 
    static int read_source_spaces(const QString& name,
                                  std::vector<std::unique_ptr<MNESourceSpace>>& spaces);
 
    static int transform_source_spaces_to(int coord_frame,
                                          const FIFFLIB::FiffCoordTrans& t,
                                          std::vector<std::unique_ptr<MNESourceSpace>>& spaces);
 
    static int restrict_sources_to_labels(std::vector<std::unique_ptr<MNESourceSpace>>& spaces,
                                          const QStringList& labels,
                                          int nlabel);
 
    static int read_label(const QString& label,
                          Eigen::VectorXi& sel);
 
    //=========================================================================================================
    int writeToStream(FIFFLIB::FiffStream::SPtr& stream, bool selected_only) const;
 
    //=========================================================================================================
    static MNEHemisphere icoDownsample(const MNEHemisphere& hemi, int icoGrade);
 
private:
    int writeVolumeInfo(FIFFLIB::FiffStream::SPtr& stream, bool selected_only) const;
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE MNELIB
 
#endif // MNESOURCESPACE_H