brainspace.gradient.alignment.procrustes_alignment¶
-
brainspace.gradient.alignment.
procrustes_alignment
(data, reference=None, n_iter=10, tol=1e-05, return_reference=False, verbose=False)[source]¶ Iterative alignment using generalized procrustes analysis.
Parameters: - data (list of ndarray, shape = (n_samples, n_feat)) – List of datasets to align.
- reference (ndarray, shape = (n_samples, n_feat), optional) – Dataset to use as reference in the first iteration. If None, the first dataset in data is used as reference. Default is None.
- n_iter (int, optional) – Number of iterations. Default is 10.
- tol (float, optional) – Tolerance for stopping criteria. Default is 1e-5.
- return_reference (bool, optional) – Whether to return the reference dataset built in the last iteration. Default is False.
- verbose (bool, optional) – Verbosity. Default is False.
Returns: - aligned (list of ndarray, shape = (n_samples, n_feat)) – Aligned datsets.
- mean_dataset (ndarray, shape = (n_samples, n_feat)) – Reference dataset built in the last iteration. Only if
return_reference == True
.