Skip to content

Commit 7877d16

Browse files
committed
DOC: Add docstring
1 parent c41e482 commit 7877d16

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

fmriprep/interfaces/images.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -609,6 +609,13 @@ class SignalExtractionOutputSpec(TraitedSpec):
609609

610610

611611
class SignalExtraction(SimpleInterface):
612+
""" Extract mean signals from a time series within a set of ROIs
613+
614+
This interface is intended to be a memory-efficient alternative to
615+
nipype.interfaces.nilearn.SignalExtraction.
616+
Not all features of nilearn.SignalExtraction are implemented at
617+
this time.
618+
"""
612619
input_spec = SignalExtractionInputSpec
613620
output_spec = SignalExtractionOutputSpec
614621

0 commit comments

Comments
 (0)