Skip to content

Commit 1a14a13

Browse files
committed
DOC: Update CompCor docs to explain new filters
1 parent ccbce0f commit 1a14a13

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

nipype/algorithms/confounds.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -360,6 +360,26 @@ class CompCor(BaseInterface):
360360
"""
361361
Interface with core CompCor computation, used in aCompCor and tCompCor
362362
363+
CompCor provides three pre-filter options, all of which include per-voxel
364+
mean removal:
365+
- polynomial: Legendre polynomial basis
366+
- cosine: Discrete cosine basis
367+
- False: mean-removal only
368+
369+
In the case of ``polynomial`` and ``cosine`` filters, a pre-filter file may
370+
be saved with a row for each volume/timepoint, and a column for each
371+
non-constant regressor.
372+
If no non-constant (mean-removal) columns are used, this file may be empty.
373+
374+
If ``ignore_initial_volumes`` is set, then the specified number of initial
375+
volumes are excluded both from pre-filtering and CompCor component
376+
extraction.
377+
Each column in the components and pre-filter files are prefixe with zeros
378+
for each excluded volume so that the number of rows continues to match the
379+
number of volumes in the input file.
380+
In addition, for each excluded volume, a column is added to the pre-filter
381+
file with a 1 in the corresponding row.
382+
363383
Example
364384
-------
365385

0 commit comments

Comments
 (0)