recon_surf.spherically_project

recon_surf.spherically_project.options_parse()[source]

Command line option parser.

Returns:
options

Object holding options.

recon_surf.spherically_project.spherically_project_surface(insurf, outsurf, use_cholmod=True)[source]

Take path to insurf, spherically projects it, outputs it to outsurf.

Parameters:
insurfPath, str

Path to input surface file.

outsurfPath, str

Path to output surface file.

use_cholmodbool, default=True

Try to use the Cholesky decomposition from the cholmod.

recon_surf.spherically_project.tria_spherical_project(tria, flow_iter=3, debug=False, use_cholmod=True)[source]

Compute the first three sphere-projected non-constant eigenfunctions.

Compute the first three non-constant eigenfunctions and then projects the spectral embedding onto a sphere. This works when the first functions have a single closed zero level set, splitting the mesh into two domains each. Depending on the original shape triangles could get inverted. We also flip the functions according to the axes that they are aligned with for the special case of brain surfaces in FreeSurfer coordinates.

Parameters:
triaTriaMesh

Triangle Mesh.

flow_iterint, default=3

Mean curv flow iterations (3 should be enough).

debugbool, default=False

Whether to print EV info to the file debug.ev.

use_cholmodbool, default=True

Try to use the Cholesky decomposition from the cholmod.

Returns:
triamesh

Triangle Mesh spherically projected.