ieeg_implantation.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef IEEG_IMPLANTATION_H
#define IEEG_IMPLANTATION_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "ieeg_global.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QString>
#include <QVector>
 
//=============================================================================================================
// DEFINE NAMESPACE IEEGLIB
//=============================================================================================================
 
namespace IEEGLIB
{
 
//=============================================================================================================
enum class IeegLeadType
{
    Depth, 
    Strip, 
    Grid   
};
 
//=============================================================================================================
struct IEEGSHARED_EXPORT IeegContact
{
    QString name;                                       
    Eigen::Vector3f position = Eigen::Vector3f::Zero(); 
    QString lead;                                       
};
 
//=============================================================================================================
struct IEEGSHARED_EXPORT IeegLead
{
    QString name;                            
    IeegLeadType type = IeegLeadType::Depth; 
    QVector<int> contacts;                   
    int rows = 0;                            
    int cols = 0;                            
};
 
//=============================================================================================================
class IEEGSHARED_EXPORT IeegImplantation
{
public:
    static constexpr float kMaxDepthSpacing = 0.006f;
 
    IeegImplantation() = default;
 
    //=========================================================================================================
    explicit IeegImplantation(const QVector<IeegContact>& contacts, const QString& coordinateSystem = QString());
 
    //=========================================================================================================
    static IeegImplantation readBids(const QString& electrodesTsv, QString* error = nullptr);

    const QVector<IeegContact>& contacts() const
    {
        return m_contacts;
    }

    const QVector<IeegLead>& leads() const
    {
        return m_leads;
    }

    QString coordinateSystem() const
    {
        return m_coordinateSystem;
    }

    bool isEmpty() const
    {
        return m_contacts.isEmpty();
    }

    bool setLeadType(const QString& lead, IeegLeadType type, int rows = 0, int cols = 0);

    int indexOf(const QString& name) const;

    Eigen::MatrixX3f positions() const;

    bool isScannerRas() const;

    IeegImplantation transformed(const Eigen::Matrix4f& trans, const QString& frame) const;
 
private:
    QVector<IeegContact> m_contacts;
    QVector<IeegLead> m_leads;
    QString m_coordinateSystem;
};
 
} // namespace IEEGLIB
 
#endif // IEEG_IMPLANTATION_H