SUSCEPTIBILITY_Correction
=========================

Susceptibility correction with FSL, 2 phase-encoded images are required to use this module

:Command: ``dmriprep``
:Module version: 0.1
:Module type: ``prep``
:Attributes: ``deform_image``, ``multi_input``
:Notes: `SUSCEPTIBILITY_Correction README <https://github.com/NIRALUser/DTIPlayground/blob/master/dtiplayground/dmri/preprocessing/modules/SUSCEPTIBILITY_Correct/README.md>`_
:Source: `dtiplayground/dmri/preprocessing/modules/SUSCEPTIBILITY_Correct <https://github.com/NIRALUser/DTIPlayground/blob/master/dtiplayground/dmri/preprocessing/modules/SUSCEPTIBILITY_Correct>`_

Protocol options
----------------

``phaseEncodingAxis``
    Phase encoding axis (list of axis index of phase encoding (0,1,2)),e.g. 0 - rl, 1 - ap(fh), 2 - si

    :Type: ``number``
    :Default: ``1``


``phaseEncodingValue``
    Phase encoding value (real number)

    :Type: ``float``
    :Default: ``0.0924``


``configurationFilePath``
    FSL topup configuration file path

    :Type: ``filepath-remote``
    :Default: ``$CONFIG_DIR/parameters/fsl/fsl_regb02b0.cnf``