Package that provides tools for brain MRI Deep Learning pre-processing.

Note

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

brainprep.qc.compute_mean_correlation(X, df_description, outdir)[source]¶

Compute mean correlation.

Parameters:

X : array (n_samples, …)

the input data.

df_description : pandas DataFrame

samples associated descriptons: must have ‘n_samples’ rows and ‘participant_id’, ‘session’, ‘run’ and ‘ni_path’ columns.

outdir : str

the destination folder.

Returns:

df_corr : pandas DataFrame

sorted input data description based on mean correlation: columns are ‘participant_id’, ‘session’, ‘run’, ‘corr_mean’.

heatmap_path : str

path to the heatmap of mean correlation.