fiff_dig_point_set.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFFLIB_FIFF_DIG_POINT_SET_H
#define FIFFLIB_FIFF_DIG_POINT_SET_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QIODevice>
#include <QList>
#include <QStringList>
 
#include "fiff_stream.h"
#include "fiff_dig_point.h"
#include <memory>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
//=============================================================================================================
// FIFFLIB FORWARD DECLARATIONS
//=============================================================================================================
 
class FiffDigPoint;
class FiffDirNode;
 
//=============================================================================================================
 
class FIFFSHARED_EXPORT FiffDigPointSet
{
public:
    using SPtr = QSharedPointer<FiffDigPointSet>;             
    using ConstSPtr = QSharedPointer<const FiffDigPointSet>;  
    using UPtr = std::unique_ptr<FiffDigPointSet>;            
    using ConstUPtr = std::unique_ptr<const FiffDigPointSet>; 
 
    //=========================================================================================================
    FiffDigPointSet();
 
    //=========================================================================================================
    FiffDigPointSet(const FiffDigPointSet& p_FiffDigPointSet);
 
    //=========================================================================================================
    FiffDigPointSet& operator=(const FiffDigPointSet& other) = default;
 
    //=========================================================================================================
    FiffDigPointSet(QList<FIFFLIB::FiffDigPoint> pointList);
 
    //=========================================================================================================
    FiffDigPointSet(QIODevice& p_IODevice);
 
    //=========================================================================================================
    ~FiffDigPointSet();
 
    //=========================================================================================================
    static bool readFromStream(FiffStream::SPtr& p_Stream, FiffDigPointSet& p_Dig);
 
    //=========================================================================================================
    static bool readPolhemusIsotrak(const QString& path,
                                    FiffDigPointSet& dig,
                                    const QStringList& chNames = QStringList(),
                                    const QString& unit = QStringLiteral("m"));
 
    //=========================================================================================================
    static bool readPolhemusFastscan(const QString& path,
                                     Eigen::MatrixX3d& points,
                                     const QString& unit = QStringLiteral("mm"),
                                     bool requireHeader = true);
 
    //=========================================================================================================
    static bool readCaptrak(const QString& path, FiffDigPointSet& dig, QStringList* chNames = nullptr);
 
    //=========================================================================================================
    static bool readEgi(const QString& path, FiffDigPointSet& dig, QStringList* chNames = nullptr);
 
    //=========================================================================================================
    static bool readLocalite(const QString& path,
                             FiffDigPointSet& dig,
                             QStringList* chNames = nullptr,
                             const QString& nasion = QString(),
                             const QString& lpa = QString(),
                             const QString& rpa = QString());
 
    //=========================================================================================================
    static bool readNeuroscanDat(const QString& path, FiffDigPointSet& dig, QStringList* chNames = nullptr);
 
    //=========================================================================================================
    inline void clear();
 
    //=========================================================================================================
    inline bool isEmpty() const;
 
    //=========================================================================================================
    inline qint32 size() const;
 
    //=========================================================================================================
    bool write(QIODevice& p_IODevice);
 
    //=========================================================================================================
    bool write(const QString& filePath, QString* errorMessage = nullptr);
 
    //=========================================================================================================
    void writeToStream(FiffStream* p_pStream);
 
    //=========================================================================================================
    const FiffDigPoint& operator[](qint32 idx) const;
 
    //=========================================================================================================
    FiffDigPoint& operator[](qint32 idx);
 
    //=========================================================================================================
    FiffDigPointSet pickTypes(QList<int> includeTypes) const;
 
    //=========================================================================================================
    FiffDigPointSet& operator<<(const FiffDigPoint& dig);
 
    //=========================================================================================================
    FiffDigPointSet& operator<<(const FiffDigPoint* dig);
 
    //=========================================================================================================
    void applyTransform(const FiffCoordTrans& coordTrans, bool bApplyInverse = false);
 
    //=========================================================================================================
    bool transformToHead();
 
    //=========================================================================================================
    QList<FiffDigPoint> getList();
 
protected:
private:
    QList<FiffDigPoint> m_qListDigPoint; 
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline void FiffDigPointSet::clear()
{
    m_qListDigPoint.clear();
}
 
//=============================================================================================================
 
inline bool FiffDigPointSet::isEmpty() const
{
    return m_qListDigPoint.size() == 0;
}
 
//=============================================================================================================
 
inline qint32 FiffDigPointSet::size() const
{
    return m_qListDigPoint.size();
}
} // namespace FIFFLIB
 
#ifndef metatype_fiffdigpointset
#define metatype_fiffdigpointset
Q_DECLARE_METATYPE(FIFFLIB::FiffDigPointSet); 
#endif
 
#ifndef metatype_fiffdigpointset_sptr
#define metatype_fiffdigpointset_sptr
Q_DECLARE_METATYPE(FIFFLIB::FiffDigPointSet::SPtr); 
#endif
 
#endif // FIFFLIB_FIFF_DIG_POINT_SET_H