Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Bring IntendedFor heuristic table from SDCFlows #2332

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion docs/sdc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,37 @@ In order to select the appropriate estimation workflow, the input BIDS dataset i
first queried to find the available field-mapping techniques
(see :py:func:`~sdcflows.workflows.base.init_sdc_estimate_wf`).
Once the field-map (or the corresponding displacement field) is estimated, the
distortion can be accounted for
distortion can be accounted for
(see :py:func:`~sdcflows.workflows.unwarp.init_sdc_unwarp_wf`).

Automatic selection of the appropriate susceptibility-distortion correction (SDC) method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If the dataset metadata indicate that more than one field map acquisition is
``IntendedFor`` (see the `BIDS Specification
<https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/01-magnetic-resonance-imaging-data.html#fieldmap-data>`__),
the following priority will be used:

1. :ref:`sdc_pepolar` (or **blip-up/blip-down**)

2. :ref:`sdc_direct_b0`

3. :ref:`sdc_phasediff`

4. :ref:`sdc_fieldmapless`


Table of behavior (fieldmap use-cases):

=============== =========== ============= ===============
Fieldmaps found ``use_syn`` ``force_syn`` Action
=============== =========== ============= ===============
True * True Fieldmaps + SyN
True * False Fieldmaps
False * True SyN
False True False SyN
False False False HMC only
=============== =========== ============= ===============

Calculating the effective echo-spacing and total-readout time
.............................................................
To solve :ref:`(1) <eq_fieldmap>`, all methods (with the exception of the
Expand Down