Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the user guide for the big picture.

3.3.2. fmralign.alignment_methods.DiagonalAlignment

class fmralign.alignment_methods.DiagonalAlignment(n_jobs=1, parallel_backend='threading')

Compute the voxelwise projection factor between X and Y.

Parameters:

n_jobs: integer, optional (default = 1)

The number of CPUs to use to do the computation. -1 means ‘all CPUs’, -2 ‘all CPUs but one’, and so on.

parallel_backend: str, ParallelBackendBase instance, None (default: ‘threading’)

Specify the parallelization backend implementation. For more informations see joblib.Parallel documentation

Attributes:

Rscipy.sparse.diags

Scaling matrix containing the optimal shrinking factor for every voxel

__init__(n_jobs=1, parallel_backend='threading')

fit(X, Y)

Parameters:

X: (n_samples, n_features) nd array

source data

Y: (n_samples, n_features) nd array

target data

transform(X)

Transform X using optimal coupling computed during fit.