Extract the hemisphere column of an atlas

hemi records which side of the brain a row sits on, as one of "left", "right" or "midline", or NA where a side does not apply. It is a closed vocabulary, enforced at construction, because it is what consumers filter and facet on.

Usage

atlas_hemi(x)

Arguments

x

brain atlas

Value

The hemi column of core, unchanged: one element per core row, in core row order, with repeats and NAs retained. A zero-length character vector when the atlas carries no hemi column.

See also

atlas_regions(), atlas_labels(), atlas_display()

Other atlas accessors: atlas_centerlines(), atlas_display(), atlas_geom(), atlas_geometry_type(), atlas_labels(), atlas_meshes(), atlas_palette(), atlas_polygons(), atlas_regions(), atlas_sf(), atlas_type(), atlas_vertices(), atlas_views(), legacy_region_map()

Examples

unique(atlas_hemi(dk()))
#> [1] "left"  "right"
unique(atlas_hemi(suit()))
#> [1] "left"    "right"   "midline"