netneurotools.metrics.navigation_wu

netneurotools.metrics.navigation_wu(nav_dist_mat, sc_mat)[source]

Compute network navigation.

Parameters:

nav_dist_mat ((N, N) array_like) – Connection length/distance matrix.
sc_mat ((N, N) array_like) – Structural connectivity matrix, only used to get connectedness.

Returns:

nav_sr (float) – Overall navigation success rate
nav_sr_node (list of float) – Nodal navigation success rate
nav_path_len ((N, N) array_like) – Navigation path length matrix, infinite if no path exists.
nav_path_hop ((N, N) array_like) – Navigation path hop matrix, infinite if no path exists.
nav_paths (list) – List of tuples containing source node, target node, path length, path hops, and the full path.

References

Seguin, C., Van Den Heuvel, M. P., & Zalesky, A. (2018). Navigation of brain networks. Proceedings of the National Academy of Sciences, 115(24), 6297-6302.

Notes

Euclidean distance between nodes are usually used for nav_dist_mat. Distances returned from this function are also calculated from nav_dist_mat. Use netneurotools.metrics.get_navigation_path_length() to get path length in other metrics.