libfs
Header-only C++11 library for accessing FreeSurfer neuroimaging data
Public Member Functions | Public Attributes | List of all members
fs::Label Struct Reference

#include <libfs.h>

Collaboration diagram for fs::Label:
Collaboration graph
[legend]

Public Member Functions

 Label ()
 Default constructor for a label.
 
 Label (std::vector< int > vertices, std::vector< float > values)
 Construct a Label from the given vertices / voxel numbers and values.
 
 Label (std::vector< int > vertices)
 Construct a Label from the given vertices / voxel numbers.
 
std::vector< bool > vert_in_label (size_t surface_num_verts) const
 Compute for each vertex of the surface whether it is inside the label.
 
size_t num_entries () const
 Return the number of entries (vertices/voxels) in this label.
 

Public Attributes

std::vector< int > vertex
 vertex indices for the data in this label if it is a surface label. These are indices into the vertices of a surface mesh to which this label belongs.
 
std::vector< float > coord_x
 x coordinates of the vertices in case of a surface label, or voxels coordinates for a volume label.
 
std::vector< float > coord_y
 y coordinates of the vertices in case of a surface label, or voxels coordinates for a volume label.
 
std::vector< float > coord_z
 z coordinates of the vertices in case of a surface label, or voxels coordinates for a volume label.
 
std::vector< float > value
 the value of the label, can represent continuous data like a p-value, or sometimes simply 1.0 or 0.0 (interpreted as int/bool) to mark vertices inside/outside of a certain area.
 

Detailed Description

Models a FreeSurfer label. Can be a surface or volume label. A label contains entries for a subset of the vertices of a mesh (or the voxels of a volume). For a surface label, the 'vertex' field contains a vertex index, the coord_* fields may contain the vertex coordinates, and the value field may contain some per-vertex descriptor or analysis result, like a p-value. For a volume label, the 'vertex' field contains a running number, the coord_* fields contain (as floats) the voxel R,A,S indices, and the value field may contain some per-voxel descriptor or analysis result, like a p-value. Note: The variable names herre assume this is a surface label, do not let that confuse you when working with volume labels.


The documentation for this struct was generated from the following file: