read_surf: Get a '"surf"' object

In ciftiTools: Tools for Reading, Writing, Viewing and Manipulating CIFTI Files

Get a "surf" object

Description

Coerce a file path to a surface GIFTI, a "gifti" object, a list with entries "pointset" and "triangle", or a "surf" to a "surf".

Usage

read_surf(surf, expected_hemisphere = NULL, resamp_res = NULL)

make_surf(surf, expected_hemisphere = NULL, resamp_res = NULL)

Arguments

surf	Either a file path to a surface GIFTI; a "gifti" read by readgii; a list with entries "pointset" and "triangle"; or, a "surf" object.
expected_hemisphere	The expected hemisphere ("left" or "right") of surf. If the hemisphere indicated in the GIFTI metadata is the opposite, an error is raised. If NULL (default), use the GIFTI hemisphere.
resamp_res	The resolution to resample the surfaces to. If NULL (default), do not resample.

Value

The "surf": a list with components "vertices" (3D spatial locations), "faces" (defined by three vertices), and "hemisphere" ("left", "right", or NULL if unknown).

See Also

Other reading: as.xifti(), info_cifti(), load_parc(), load_surf(), read_cifti(), read_xifti2()

Other surface-related: add_surf(), boundary_mask_surf(), edit_mask_surf(), even_vert_samp(), is.surf(), load_surf(), mask_surf(), resample_surf(), rotate_surf(), surf_area(), view_surf(), write_surf_gifti()

ciftiTools documentation built on April 4, 2025, 1:09 a.m.