Skip to content

Commit d0dd706

Browse files
committed
doc: how to disable artifactdetect's norm_threshold
1 parent c650793 commit d0dd706

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

nipype/algorithms/rapidart.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,9 @@ class ArtifactDetect(BaseInterface):
278278
279279
Uses intensity and motion parameters to infer outliers. If `use_norm` is
280280
True, it computes the movement of the center of each face a cuboid centered
281-
around the head and returns the maximal movement across the centers.
281+
around the head and returns the maximal movement across the centers. If you
282+
wish to use individual thresholds instead, import `Undefined` from
283+
`nipype.interfaces.base` and set `....inputs.use_norm = Undefined`
282284
283285
284286
Examples
@@ -591,13 +593,13 @@ class StimCorrInputSpec(BaseInterfaceInputSpec):
591593
desc="SPM mat file (use pre-estimate SPM.mat file)")
592594
concatenated_design = traits.Bool(mandatory=True,
593595
desc=("state if the design matrix "
594-
"contains concatenated sessions")
596+
"contains concatenated sessions"))
595597

596598

597599
class StimCorrOutputSpec(TraitedSpec):
598600
stimcorr_files = OutputMultiPath(File(exists=True),
599601
desc=("List of files containing "
600-
"correlation values")
602+
"correlation values"))
601603

602604

603605
class StimulusCorrelation(BaseInterface):

nipype/algorithms/tests/test_auto_ArtifactDetect.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ def test_ArtifactDetect_inputs():
4040
usedefault=True,
4141
),
4242
use_norm=dict(requires=['norm_threshold'],
43+
usedefault=True,
4344
),
4445
zintensity_threshold=dict(mandatory=True,
4546
),

0 commit comments

Comments
 (0)