mne_surface_or_volume.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef MNESURFACEORVOLUME_H
#define MNESURFACEORVOLUME_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "mne_global.h"
#include <mne/mne_types.h>
#include "mne_vol_geom.h"
#include "mne_mgh_tag_group.h"
#include "mne_triangle.h"
#include "mne_nearest.h"
#include "mne_patch_info.h"
#include <fiff/fiff_sparse_matrix.h>
#include <fiff/fiff_coord_trans.h>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
 
#include <memory>
#include <optional>
#include <vector>
 
#include <QStringList>
#include <QDebug>
 
 
#define FIFF_MNE_SOURCE_SPACE_NNEIGHBORS    3594    /* Number of neighbors for each source space point (used for volume source spaces) */
#define FIFF_MNE_SOURCE_SPACE_NEIGHBORS     3595    /* Neighbors for each source space point (used for volume source spaces) */
 
#define FIFFV_MNE_COORD_SURFACE_RAS   FIFFV_COORD_MRI    /* The surface RAS coordinates */
 
#define TRIANGLE_FILE_MAGIC_NUMBER  (0xfffffe)
#define NEW_QUAD_FILE_MAGIC_NUMBER  (0xfffffd)
#define QUAD_FILE_MAGIC_NUMBER      (0xffffff)
 
#define TAG_OLD_SURF_GEOM           20
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
namespace FIFFLIB {
    class FiffDigitizerData;
}
 
//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================
 
namespace MNELIB
{
 
//=============================================================================================================
// MNELIB FORWARD DECLARATIONS
//=============================================================================================================
 
class MNESourceSpace;
class MNESurface;
class MNEMshDisplaySurface;
class MNEProjData;
class FilterThreadArg;
 
//=============================================================================================================
class MNESHARED_EXPORT MNESurfaceOrVolume
{
public:
    typedef QSharedPointer<MNESurfaceOrVolume> SPtr;              
    typedef QSharedPointer<const MNESurfaceOrVolume> ConstSPtr;   
 
    /*
     * Eigen convenience types – row-major so that row(i).data() gives
     * a contiguous 3-element pointer, matching the old float** / int** layout.
     */
    typedef Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> PointsT;     
    typedef Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> NormalsT;    
    typedef Eigen::Matrix<int,   Eigen::Dynamic, 3, Eigen::RowMajor> TrianglesT;  
 
    //=========================================================================================================
    MNESurfaceOrVolume();
 
    //=========================================================================================================
    virtual ~MNESurfaceOrVolume();
 
    MNESurfaceOrVolume(const MNESurfaceOrVolume&) = default;
    MNESurfaceOrVolume& operator=(const MNESurfaceOrVolume&) = default;
    MNESurfaceOrVolume(MNESurfaceOrVolume&&) = default;
    MNESurfaceOrVolume& operator=(MNESurfaceOrVolume&&) = default;

    static double solid_angle (const Eigen::Vector3f& from, /* From this point... */
                               const MNELIB::MNETriangle& tri);

    void add_uniform_curv();

    void add_triangle_data();
 

    static void compute_cm(const PointsT& rr, int np, float (&cm)[3]);

    void compute_surface_cm();

    void calculate_vertex_distances();

    int add_vertex_normals();

    int add_geometry_info(bool do_normals, bool check_too_many_neighbors);

    int add_geometry_info(bool do_normals);

    int add_geometry_info2(bool do_normals);
 

    Eigen::VectorXi nearestVertIdx() const;

    Eigen::VectorXd nearestDistVec() const;

    void setNearestData(const Eigen::VectorXi& nearestIdx, const Eigen::VectorXd& nearestDist);
 
 
public:
    int             type;          
    QString         subject;       
    int             id;            
    int             coord_frame;   
    /*
     * These relate to the FreeSurfer way
     */
    std::optional<MNEVolGeom> vol_geom;         
    std::optional<MNEMghTagGroup> mgh_tags;     
    /*
     * These are meaningful for both surfaces and volumes
     */
    int              np;        
    PointsT          rr;        
    NormalsT         nn;        
    float            cm[3];     

    Eigen::Map<const Eigen::Vector3f> point(int k) const { return Eigen::Map<const Eigen::Vector3f>(rr.row(k).data()); }
    Eigen::Map<Eigen::Vector3f> point(int k) { return Eigen::Map<Eigen::Vector3f>(rr.row(k).data()); }
    Eigen::Map<const Eigen::Vector3f> normal(int k) const { return Eigen::Map<const Eigen::Vector3f>(nn.row(k).data()); }
 
    Eigen::VectorXi   inuse;    
    Eigen::VectorXi   vertno;   
    int              nuse;      
 
    std::vector<Eigen::VectorXi> neighbor_vert; 
    Eigen::VectorXi   nneighbor_vert; 
    std::vector<Eigen::VectorXf> vert_dist;     
    /*
     * These are for surfaces only
     */
    float            sigma;     
 
    int              ntri;      
    std::vector<MNETriangle> tris; 
    TrianglesT       itris;     
    float            tot_area;  
 
    int              nuse_tri;      
    std::vector<MNETriangle> use_tris; 
    TrianglesT       use_itris;     
 
    std::vector<Eigen::VectorXi> neighbor_tri;    
    Eigen::VectorXi   nneighbor_tri;    
 
    std::vector<MNENearest> nearest; 
    std::vector<std::optional<MNEPatchInfo>> patches; 
 
    FIFFLIB::FiffSparseMatrix dist;         
    float            dist_limit;    
 
    Eigen::VectorXf   curv; 
    Eigen::VectorXf   val;  
    /*
     * These are for volumes only
     */
    std::optional<FIFFLIB::FiffCoordTrans>  voxel_surf_RAS_t;   
    int             vol_dims[3];        
    float           voxel_size[3];      
    std::optional<FIFFLIB::FiffSparseMatrix> interpolator;       
    QString         MRI_volume;         
    std::optional<FIFFLIB::FiffCoordTrans>  MRI_voxel_surf_RAS_t; 
    std::optional<FIFFLIB::FiffCoordTrans>  MRI_surf_RAS_RAS_t; 
    int             MRI_vol_dims[3];       
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE MNELIB
 
#endif // MNESURFACEORVOLUME_H