surf.metric.properties: Compute metric surface properties.
In dfsp-spirit/nitools: Managing and Visualizing Brain Surface Data

surf.metric.properties

R Documentation

Compute metric surface properties.

Description

Compute metric surface properties.

Usage

surf.metric.properties(surface, is_template, template_scale_factor = 1.56)

Arguments

`surface`	an fs.surface instance, and for the typical use case of this function, a spherical surface.
`is_template`	logical, whether the surface comes from a template subject.
`template_scale_factor`	double, the template scale factor

Value

named list of metric surface properties.

Examples

## Not run: 
surface = subject.surface(fsaverage.path(), "fsaverage3", hemi="lh");
mp = surf.metric.properties(surface, is_template = TRUE);

## End(Not run)

dfsp-spirit/nitools documentation built on Jan. 26, 2024, 8:24 p.m.