annotation.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef ANNOTATION_H
#define ANNOTATION_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fs_global.h"
#include "colortable.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QString>
#include <QSharedPointer>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// DEFINE NAMESPACE FSLIB
//=============================================================================================================
 
namespace FSLIB
{
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
class Label;
class Surface;
 
//=============================================================================================================
class FSSHARED_EXPORT Annotation
{
 
public:
    typedef QSharedPointer<Annotation> SPtr;            
    typedef QSharedPointer<const Annotation> ConstSPtr; 
    //=========================================================================================================
    Annotation();
 
    //=========================================================================================================
    explicit Annotation(const QString& p_sFileName);
 
    //=========================================================================================================
    explicit Annotation(const QString &subject_id, qint32 hemi, const QString &surf, const QString &subjects_dir);
 
    //=========================================================================================================
    explicit Annotation(const QString &path, qint32 hemi, const QString &surf);
 
    //=========================================================================================================
    ~Annotation();
 
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    inline bool isEmpty() const;
 
    //=========================================================================================================
    inline qint32 hemi() const;
 
    //=========================================================================================================
    inline Eigen::VectorXi& getVertices();
 
    //=========================================================================================================
    inline const Eigen::VectorXi getVertices() const;
 
    //=========================================================================================================
    inline Eigen::VectorXi& getLabelIds();
 
    //=========================================================================================================
    inline const Eigen::VectorXi getLabelIds() const;
 
    //=========================================================================================================
    inline Colortable& getColortable();
 
    //=========================================================================================================
    inline const Colortable getColortable() const;
 
    //=========================================================================================================
    static bool read(const QString &subject_id, qint32 hemi, const QString &atlas, const QString &subjects_dir, Annotation &p_Annotation);
 
    //=========================================================================================================
    static bool read(const QString &path, qint32 hemi, const QString &atlas, Annotation &p_Annotation);
 
    //=========================================================================================================
    static bool read(const QString &p_sFileName, Annotation &p_Annotation);
 
    //=========================================================================================================
    bool toLabels(const Surface &p_surf,
                  QList<Label> &p_qListLabels,
                  QList<Eigen::RowVector4i> &p_qListLabelRGBAs,
                  const QStringList& lLabelPicks = QStringList()) const;
 
    //=========================================================================================================
    inline QString filePath() const;
 
    //=========================================================================================================
    inline QString fileName() const;
 
private:
    QString m_sFileName;        
    QString m_sFilePath;        
    qint32 m_iHemi;             
    Eigen::VectorXi m_Vertices;        
    Eigen::VectorXi m_LabelIds;        
    Colortable m_Colortable;    
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline qint32 Annotation::hemi() const
{
    return m_iHemi;
}
 
//=============================================================================================================
 
inline bool Annotation::isEmpty() const
{
    return m_iHemi == -1;
}
 
//=============================================================================================================
 
inline Eigen::VectorXi& Annotation::getVertices()
{
    return m_Vertices;
}
 
//=============================================================================================================
 
inline const Eigen::VectorXi Annotation::getVertices() const
{
    return m_Vertices;
}
 
//=============================================================================================================
 
inline Eigen::VectorXi& Annotation::getLabelIds()
{
    return m_LabelIds;
}
 
//=============================================================================================================
 
inline const Eigen::VectorXi Annotation::getLabelIds() const
{
    return m_LabelIds;
}
 
//=============================================================================================================
 
inline Colortable& Annotation::getColortable()
{
    return m_Colortable;
}
 
//=============================================================================================================
 
inline const Colortable Annotation::getColortable() const
{
    return m_Colortable;
}
 
//=============================================================================================================
 
inline QString Annotation::filePath() const
{
    return m_sFilePath;
}
 
//=============================================================================================================
 
inline QString Annotation::fileName() const
{
    return m_sFileName;
}
} // NAMESPACE
 
#endif // ANNOTATION_H