mvpa2.misc.surfing.volsurf.VolSurfMaximalMapping

Inheritance diagram of VolSurfMaximalMapping
class mvpa2.misc.surfing.volsurf.VolSurfMaximalMapping(vg, white, pial, intermediate=None, nsteps=10, start_fr=0.0, stop_fr=1.0, start_mm=0, stop_mm=0)

Represents the maximal mapping from nodes to voxels. ‘maximal’, in this context, means that to each node all voxels are associated that are contained in lines connecting white and grey matter.

Each voxel can be associated with multiple nodes.

Parameters:

volgeom: volgeom.VolGeom

Volume geometry

white: surf.Surface

Surface representing white-grey matter boundary

pial: surf.Surface

Surface representing pial-grey matter boundary

intermediate: surf.Surface (default: None).

Surface representing intermediate surface. If omitted it is the node-wise average of white and pial.

nsteps: int (default: 10)

Number of steps from white to pial surface

start_fr: float (default: 0)

Relative start position of line in gray matter, 0.=white surface, 1.=pial surface.

stop_fr: float (default: 1)

Relative stop position of line (as in see start).

start_mm: float (default: 0)

Absolute start position offset (as in start_fr).

stop_mm: float (default: 0)

Absolute start position offset (as in start_fr).

Notes

‘pial’ and ‘white’ should have the same topology.

Attributes

intermediate_surface Returns the node-wise average of the pial and white surface
pial_surface Returns the pial surface
volgeom Returns the volume geometry
white_surface Returns the white surface

Methods

coordinates_to_grey_distance_mm(nodes, xyz) Computes the grey position of coordinates in metric units
get_node2voxels_mapping() Returns a mapping from nodes to voxels
get_parameter_dict() Returns a dictionary with the most important parameters
surf_project_nodewise(xyz) Projects coordinates on lines connecting pial and white matter.
surf_project_weights(nodes, xyz) Computes relative position of xyz on lines from pial to white matter.
surf_project_weights_nodewise(xyz) Computes relative position of xyz on lines from pial to white matter.
surf_unproject_weights_nodewise(weights) Maps relative positions in grey matter to coordinates
voxel_count_nifti_image() Returns a NIFTI image indicating how often each voxel is selected.
get_node2voxels_mapping()

Returns a mapping from nodes to voxels