aslprep.interfaces.confounds module

Interfaces for calculating and collecting confounds.

class GatherConfounds(from_file=None, resource_monitor=None, **inputs)

Bases: SimpleInterface

Combine various sources of confounds in one TSV file.

Optional Inputs:

• dvars (a pathlike object or string representing an existing file) – File containing DVARS.

• fd (a pathlike object or string representing an existing file) – Input framewise displacement.

• motion (a pathlike object or string representing an existing file) – Input motion parameters.

• rmsd (a pathlike object or string representing an existing file) – Input RMS framewise displacement.

• signals (a pathlike object or string representing an existing file) – Input signals.

• std_dvars (a pathlike object or string representing an existing file) – File containing standardized DVARS.

Outputs:

• confounds_file (a pathlike object or string representing an existing file) – Output confounds file.

• confounds_list (a list of items which are a string) – List of headers.