CorticalSurfaces.CorticalSurfaceMethod
CorticalSurface(lhem::Hemisphere, rhem::Hemisphere)

Make a CorticalSurface from a left and a right Hemisphere, in that order

CorticalSurfaces.HemisphereMethod
Hemisphere(medial_wall::BitVector)

Make a placeholder Hemisphere struct, without meaningful coordinates, from just a BitVector representing medial wall membership

CorticalSurfaces.HemisphereMethod
Hemisphere(nvertices::Int)

Make a meaningless, but functional, placeholder Hemisphere of a certain size

CorticalSurfaces.HemisphereMethod
Hemisphere(coords::Matrix, medial_wall::BitVector)

Make a Hemisphere from a Matrix of xyz coordinates and a BitVector denoting medial wall membership

Base.getindexMethod
getindex(c, h)

Index into the L or R Hemisphere of a CorticalSurface

Base.getindexMethod
 getindex(surf, s, Inclusive())

Access supplementary spatial data s::Symbol for a SurfaceSpace. Optionally pass a MedialWallIndexing trait Inclusive() or Exclusive() to inform handling of medial wall (default is Inclusive()).

Base.haskeyMethod
haskey(surf, k)

Check whether a SurfaceSpace has the symbol k among its supplementary spatial data

Base.keysMethod
keys(surf)

Get the names of the supplementary data elements, if any, that exist for a SurfaceSpace

Base.sizeMethod
size(surf, mw)

Get the number of vertices of a SurfaceSpace, Exclusive() or Inclusive() of medial wall.

Base.sizeMethod
size(surf)

Get the number of vertices of a SurfaceSpace, inclusive of medial wall.

CorticalSurfaces.brainstructureMethod
brainstructure(surf)

Get the BrainStructure designation (CORTEX_LEFT or CORTEX_RIGHT) of a Hemisphere struct surf, or, in the event that surf is a CorticalSurface, a Vector of both its left and right hemisphere labels.

CorticalSurfaces.collapseMethod
collapse(inds, surface)

Map a set of Inclusive() vertex indices to a collapsed (Exclusive()) range

CorticalSurfaces.coordinatesMethod
coordinates(surf)

Get coordinates from a SurfaceSpace, Inclusive() or Exclusive() of medial wall. Each column of the output represents a vertex, and the rows represent x, y, and z.

CorticalSurfaces.coordinatesMethod
coordinates(surf)

Get coordinates from a SurfaceSpace, inclusive of medial wall. Each column of the output represents a vertex, and the rows represent x, y, and z.

CorticalSurfaces.expandMethod
expand(inds, surface)

Map a set of Exclusive() vertex indices to an expanded (Inclusive()) range

CorticalSurfaces.make_adjacency_matrixMethod
 make_adjacency_matrix(neighbors)

Given an adjacency list – here, a Vector where each element v represents a vertex and contains a Vector{Int} listing that vertex's neighbors – of length nvertices, construct a SparseMatrixCSC adjacency matrix

CorticalSurfaces.medial_wallMethod
medial_wall(s)

Get the medial wall BitVector from a SurfaceSpace struct, where true denotes medial wall membership, false otherwise.

CorticalSurfaces.padMethod
pad(x, surface; sentinel)

Grow vector x to size(surface, Inclusive()) by padding it with a provided sentinel value along the medial wall. If no sentinel value is specified, then by default NaN will be used if T <: AbstractFloat, or zero(T) otherwise.

CorticalSurfaces.trimMethod
trim(x, surface)

Shrink x to size(surface, Exclusive()) by trimming out medial wall indices

CorticalSurfaces.verticesMethod
vertices(s, mw)

Get vertex numbers from a SurfaceSpace struct, Inclusive() or Exclusive() of medial wall.