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.2.1. fmralign.template_alignment.TemplateAlignment

class fmralign.template_alignment.TemplateAlignment(alignment_method='identity', n_pieces=1, clustering='kmeans', scale_template=False, n_iter=2, save_template=None, mask=None, smoothing_fwhm=None, standardize=False, detrend=None, target_affine=None, target_shape=None, low_pass=None, high_pass=None, t_r=None, memory=Memory(location=None), memory_level=0, n_jobs=1, verbose=0)

Decompose the source images into regions and summarize subjects information in a template, then use pairwise alignment to predict new contrast for target subject.

__init__(alignment_method='identity', n_pieces=1, clustering='kmeans', scale_template=False, n_iter=2, save_template=None, mask=None, smoothing_fwhm=None, standardize=False, detrend=None, target_affine=None, target_shape=None, low_pass=None, high_pass=None, t_r=None, memory=Memory(location=None), memory_level=0, n_jobs=1, verbose=0)

Parameters:

alignment_method: string

Algorithm used to perform alignment between X_i and Y_i : * either ‘identity’, ‘scaled_orthogonal’, ‘optimal_transport’, ‘ridge_cv’, ‘permutation’, ‘diagonal’, * or an instance of one of alignment classes (imported from fmralign.alignment_methods)

n_pieces: int, optional (default = 1)

Number of regions in which the data is parcellated for alignment. If 1 the alignment is done on full scale data. If > 1, the voxels are clustered and alignment is performed on each cluster applied to X and Y.

clusteringstring or 3D Niimg optional (defaultkmeans)

‘kmeans’, ‘ward’, ‘rena’, ‘hierarchical_kmeans’ method used for clustering of voxels based on functional signal, passed to nilearn.regions.parcellations If 3D Niimg, image used as predefined clustering, n_pieces is then ignored.

scale_template: boolean, default False

rescale template after each inference so that it keeps the same norm as the average of training images.

n_iter: int

number of iteration in the alternate minimization. Each img is aligned n_iter times to the evolving template. If n_iter = 0, the template is simply the mean of the input images.

save_template: None or string(optional)

If not None, path to which the template will be saved.

mask: Niimg-like object, instance of NiftiMasker or

MultiNiftiMasker, optional (default = None)

Mask to be used on data. If an instance of masker is passed, then its mask will be used. If no mask is given, it will be computed automatically by a MultiNiftiMasker with default parameters.

smoothing_fwhm: float, optional (default = None)

If smoothing_fwhm is not None, it gives the size in millimeters of the spatial smoothing to apply to the signal.

standardize: boolean, optional (default = None)

If standardize is True, the time-series are centered and normed: their variance is put to 1 in the time dimension.

detrend: boolean, optional (default = None)

This parameter is passed to nilearn.signal.clean. Please see the related documentation for details

target_affine: 3x3 or 4x4 matrix, optional (default = None)

This parameter is passed to nilearn.image.resample_img. Please see the related documentation for details.

target_shape: 3-tuple of integers, optional (default = None)

This parameter is passed to nilearn.image.resample_img. Please see the related documentation for details.

low_pass: None or float, optional (default = None)

This parameter is passed to nilearn.signal.clean. Please see the related documentation for details.

high_pass: None or float, optional (default = None)

This parameter is passed to nilearn.signal.clean. Please see the related documentation for details.

t_r: float, optional (default = None)

This parameter is passed to nilearn.signal.clean. Please see the related documentation for details.

memory: instance of joblib.Memory or string (default = None)

Used to cache the masking process and results of algorithms. By default, no caching is done. If a string is given, it is the path to the caching directory.

memory_level: integer, optional (default = None)

Rough estimator of the amount of memory used by caching. Higher value means more memory for caching.

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.

verbose: integer, optional (default = 0)

Indicate the level of verbosity. By default, nothing is printed.