is.surf: Validate a '"surf"' object (vertices + faces)

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

Validate a "surf" object (vertices + faces)

Description

Check if object is valid for xifti$surf$cortex_left or xifti$surf$cortex_right, where xifti is a "xifti" object.

Usage

is.surf(x)

Arguments

x	The putative "surf".

Details

This is a helper function for is.xifti.

Requirements: the "surf" must be a list of three components: "vertices", "faces", and "hemisphere". The first two should each be a numeric matrix with three columns. The values in "vertices" represent spatial coordinates whereas the values in "faces" represent vertex indices defining the face. Thus, values in "faces" should be integers between 1 and the number of vertices. The last list entry, "hemisphere", should be "left", "right", or NULL indicating the brain hemisphere which the surface represents.

Value

Logical. Is x a valid "surf"?

See Also

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

ciftiTools documentation built on Oct. 4, 2024, 1:12 a.m.