brainspace.mesh.mesh_elements.get_immediate_distance

brainspace.mesh.mesh_elements.get_immediate_distance(surf, metric='euclidean', mask=None, dtype=<class 'float'>)[source]

Get immediate distance matrix.

Parameters:
  • surf (vtkDataSet or BSDataSet) – Input surface.
  • mask (1D ndarray, optional) – Binary mask. If specified, only use points within the mask. Default is None.
  • metric ({'euclidean', 'sqeuclidean'}, optional) – Distance metric. Default is ‘euclidean’.
  • dtype (dtype, optional) – Data type. Default is float.
Returns:

dist (sparse matrix, shape (n_points, n_points)) – Immediate distance matrix.

See also

get_immediate_adjacency, get_ring_adjacency, get_ring_distance

Notes

Immediate distance: Euclidean distance with all points that share and edge with current point.