nigsp.operations.surrogates.sc_informed¶

nigsp.operations.surrogates.sc_informed(timeseries, eigenvec, n_surr=1000, seed=124, stack=False)[source]¶

Create surrogates informed by the real structural connectivity.

Parameters:

timeseriesnumpy.ndarray: A 3D (or less) array coding a timeseries in the second axis (axis 1).
eigenvecnumpy.ndarray: The eigenvector matrix from a previous Laplacian decomposition.
n_surrint, optional: The number of surrogates to create.
seedint or None, optional: The seed to reinitialise the RNG - used for replicability.
stackbool, optional: If True, append the real matrix at the end of the stack.

Returns:

numpy.ndarray: The surrogate matrix, of shape (timeseries.shape, n_surr).

Raises: