Note

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

nilearn.signal.clean#

nilearn.signal.clean(signals, runs=None, detrend=True, standardize='zscore', sample_mask=None, confounds=None, standardize_confounds=True, filter='butterworth', low_pass=None, high_pass=None, t_r=2.5, ensure_finite=False)[source]#

Improve SNR on masked fMRI signals.

This function can do several things on the input signals, in the following order:

detrend
low- and high-pass filter
remove confounds
standardize

Low-pass filtering improves specificity.

High-pass filtering should be kept small, to keep some sensitivity.

Filtering is only meaningful on evenly-sampled signals.

According to 1, removal of confounds will be done orthogonally to temporal filters (low- and/or high-pass filters), if both are specified.

Parameters

signalsnumpy.ndarray

Timeseries. Must have shape (instant number, features number). This array is not modified.

runsnumpy.ndarray, optional

Add a run level to the cleaning process. Each run will be cleaned independently. Must be a 1D array of n_samples elements. Default is None.

confoundsnumpy.ndarray, str, pandas.DataFrame or list of

Confounds timeseries. Shape must be (instant number, confound number), or just (instant number,) The number of time instants in signals and confounds must be identical (i.e. signals.shape[0] == confounds.shape[0]). If a string is provided, it is assumed to be the name of a csv file containing signals as columns, with an optional one-line header. If a list is provided, all confounds are removed from the input signal, as if all were in the same array. Default is None.

sample_maskNone, numpy.ndarray, list, tuple, or list of

shape: (number of scans - number of volumes removed, ) Masks the niimgs along time/fourth dimension to perform scrubbing (remove volumes with high motion) and/or non-steady-state volumes. This masking step is applied before signal cleaning. When supplying run information, sample_mask must be a list containing sets of indexes for each run.

New in version 0.8.0.

Default is None.

t_rfloat or None, optional

Repetition time, in seconds (sampling period). Set to None if not provided. Default=None. Default=2.5.

filter{‘butterworth’, ‘cosine’, False}, optional

Filtering methods:

‘butterworth’: perform butterworth filtering.

‘cosine’: generate discrete cosine transformation drift terms.

False: Do not perform filtering.

Default=’butterworth’.

low_passfloat or None, optional

Low cutoff frequency in Hertz. If specified, signals above this frequency will be filtered out. If None, no low-pass filtering will be performed. Default=None.

Note

low_pass is not implemented for filter=’cosine’.

high_passfloat, optional

High cutoff frequency in Hertz. If specified, signals below this frequency will be filtered out. Default=None.

detrendbool, optional

Whether to detrend signals or not.

standardize{‘zscore’, ‘psc’, False}, optional

Strategy to standardize the signal:

‘zscore’: The signal is z-scored. Timeseries are shifted to zero mean and scaled to unit variance.

‘psc’: Timeseries are shifted to zero mean value and scaled to percent signal change (as compared to original mean signal).

True: The signal is z-scored (same as option zscore). Timeseries are shifted to zero mean and scaled to unit variance.

False: Do not standardize the data.

Default=”zscore”.

standardize_confoundsbool, optional

If set to True, the confounds are z-scored: their mean is put to 0 and their variance to 1 in the time dimension. Default=True.

ensure_finitebool, optional

If True, the non-finite values (NANs and infs) found in the data will be replaced by zeros. Default=False.

Returns

cleaned_signalsnumpy.ndarray: Input signals, cleaned. Same shape as signals.