surf.avg.vertexradius: Compute average distance from the origin to each vertex.

In dfsp-spirit/fsbrain: Managing and Visualizing Brain Surface Data

Compute average distance from the origin to each vertex.

Description

Compute average distance from the origin to each vertex.

Usage

surf.avg.vertexradius(surface, with_stddev = FALSE)

Arguments

surface	an fs.surface instance, and for the typical use case of this function, a spherical surface.
with_stddev	logical, whether to compute the standard deviation as well and return a named list with the 'avg' and the 'stddev' instead.

Value

scalar double, the average distance.

Note

This is used to determine the sphere radius for spherical surfaces. It is assumed that the sphere is centered at the origin (0,0,0).

Examples

## Not run: 
spherical_surface = subject.surface(fsaverage.path(), "fsaverage3",
  surface="sphere", hemi="lh");
vr = fsbrain:::surf.avg.vertexradius(spherical_surface);
# Show histogram to verify that the surface is a sphere centered at 0,0,0:
hist(freesurferformats::vertexdists.to.point(spherical_surface, c(0,0,0)));
# Plot the coords and a point at the origin:
fsbrain::highlight.points.spheres(rbind(spherical_surface$vertices, c(0,0,0)));

## End(Not run)

dfsp-spirit/fsbrain documentation built on Nov. 28, 2024, 10:29 a.m.