brainconn.reference.latmio_dir

latmio_dir(R, itr, D=None)

This function “latticizes” a directed network, while preserving the in- and out-degree distributions. In weighted networks, the function preserves the out-strength but not the in-strength distributions.

Parameters:

• R (NxN numpy.ndarray) – directed binary/weighted connection matrix
• itr (int) – rewiring parameter. Each edge is rewired approximately itr times.
• D (numpy.ndarray | None) – distance-to-diagonal matrix. Defaults to the actual distance matrix if not specified.

Returns:

• Rlatt (NxN numpy.ndarray) – latticized network in original node ordering
• Rrp (NxN numpy.ndarray) – latticized network in node ordering used for latticization
• ind_rp (Nx1 numpy.ndarray) – node ordering used for latticization
• eff (int) – number of actual rewirings carried out