Skip to content

Commit

Permalink
DOC: Update expected estimators
Browse files Browse the repository at this point in the history
  • Loading branch information
effigies committed Apr 20, 2023
1 parent 69f4407 commit f091c80
Showing 1 changed file with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions sdcflows/utils/wrangler.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,11 @@ def find_estimators(
... force_fmapless=True,
... ) # doctest: +ELLIPSIS
[FieldmapEstimation(sources=<3 files>, method=<EstimatorType.PHASEDIFF: 3>,
bids_id='auto_00000'),
FieldmapEstimation(sources=<3 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_00001')]
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...')]
Likewise in a more comprehensive dataset:
Expand All @@ -190,13 +192,23 @@ def find_estimators(
... force_fmapless=True,
... ) # doctest: +ELLIPSIS
[FieldmapEstimation(sources=<4 files>, method=<EstimatorType.PEPOLAR: 2>,
bids_id='auto_00002'),
FieldmapEstimation(sources=<7 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_00003'),
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_00004'),
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_00005')]
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_...')]
Because "*dataset A*" contains very few metadata fields available, "*fieldmap-less*"
heuristics come back empty (BOLD and DWI files are missing
Expand Down Expand Up @@ -235,9 +247,9 @@ def find_estimators(
... force_fmapless=False,
... ) # doctest: +ELLIPSIS
[FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_00011'),
bids_id='auto_...'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_00012')]
bids_id='auto_...')]
When the ``B0FieldIdentifier`` metadata is set for one or more fieldmaps, then
the heuristics that use ``IntendedFor`` are dismissed:
Expand All @@ -262,7 +274,7 @@ def find_estimators(
[FieldmapEstimation(sources=<5 files>, method=<EstimatorType.PEPOLAR: 2>,
bids_id='pepolar4pe'),
FieldmapEstimation(sources=<2 files>, method=<EstimatorType.ANAT: 5>,
bids_id='auto_00000')]
bids_id='auto_...')]
"""
from .misc import create_logger
Expand Down

0 comments on commit f091c80

Please sign in to comment.