hcp_transmit_bias_individual_adjustment#

qx_utilities.hcp.hcp_transmit_bias_individual_adjustment.hcp_transmit_bias_individual_adjustment(sinfo, options, overwrite=False, thread=0)#

hcp_transmit_bias_individual_adjustment([... processing options])

Runs the HCP Transmit Bias Pipeline Phase 3, Individual Adjustment.

Parameters

--batchfile (str, default ''):

The batch.txt file with all the sessions information.

--sessionsfolder (str, default '.'):

The path to the study/sessions folder, where the imaging data is supposed to go.

--parsessions (int, default 1):

How many sessions to run in parallel.

--overwrite (str, default 'no'):

Whether to overwrite existing data (yes) or not (no). Note that previous data is deleted before the run, so in the case of a failed command run, previous results are lost.

--hcp_suffix (str, default ''):

Specifies a suffix to the session id if multiple variants are run, empty otherwise.

--logfolder (str, default ''):

The path to the folder where runlogs and comlogs are to be stored, if other than default.

--hcp_gmwm_template (str, default ''):

Location of the GMWMtemplate, the file containing GM+WM volume ROI.

--hcp_regname (str, default 'MSMSulc'):

Input registration name.

--hcp_transmit_mode (str, default ''):

What type of transmit bias correction to apply, options and required inputs are:

a) AFI: actual flip angle sequence with two different echo times, requires the following parameters: afi-tr-one,afi-tr-two,afi-angle, group-corrected-myelin.

b) B1Tx: b1 transmit sequence magnitude/phase pair, requires the following parameters: group-corrected-myelin.

c) PseudoTransmit: use spin echo fieldmaps, SBRef, and a template transmit-corrected myelin map to derive empirical correction, requires the following parameters: myelin-template, group-uncorrected-myelin, reference-value.

--hcp_group_corrected_myelin (str, default ''):

The group-corrected myelin file from AFI or B1Tx.

--hcp_afi_tr_one (str, default ''):

TR of first AFI frame.

--hcp_afi_tr_two (str, default ''):

TR of second AFI frame.

--hcp_afi_angle (str, default ''):

Target flip angle of AFI sequence.

--hcp_myelin_template (str, default ''):

Expected transmit-corrected group-average myelin pattern (for testing correction parameters).

--hcp_group_uncorrected_myelin (str, default ''):

The group-average uncorrected myelin file (to set the appropriate scaling of the myelin template).

--hcp_pt_reference_value_file (str, default ''):

Text file containing the value in the pseudotransmit map where the flip angle best matches the intended angle, from the Phase2 group script.

--hcp_transmit_res (str, default ''):

Resolution to use for transmit field, default equal to hcp_grayordinatesres.

--hcp_regname (str, default 'MSMSulc'):

The name of the registration used.

--hcp_lowresmesh (int, default 32):

Mesh resolution.

--hcp_grayordinatesres (int, default 2):

The size of voxels for the subcortical and cerebellar data in grayordinate space in mm.

--hcp_matlab_mode (str, default default detailed below):

Specifies the Matlab version, can be 'interpreted', 'compiled' or 'octave'. Inside the container 'compiled' will be used, outside 'interpreted' is the default.

--hcp_manual_receive (str, default ''):

Whether Phase1 used unprocessed scans to correct for not using PSN when acquiring scans.

Notes

hcp_transmit_bias_individual_adjustment parameter mapping:

QuNex parameter

HCPpipelines parameter

hcp_gmwm_template

gmwm-template

hcp_regname

reg-name

hcp_transmit_mode

mode

hcp_group_corrected_myelin

group-corrected-myelin

hcp_afi_tr_one

afi-tr-one

hcp_afi_tr_two

afi-tr-two

hcp_afi_angle

afi-angle

hcp_myelin_template

myelin-template

hcp_group_uncorrected_myelin

group-uncorrected-myelin

hcp_pt_reference_value_file

pt-reference-value-file

hcp_transmit_res

transmit-res

hcp_regname

reg-name

hcp_lowresmesh

low-res-mesh

hcp_grayordinatesres

grayordinates-res

hcp_matlab_mode

matlab-run-mode

hcp_manual_receive

manual-receive

Examples

Example run:

qunex hcp_transmit_bias_individual_adjustment \
    --sessionsfolder="<path_to_study_folder>/sessions" \
    --batchfile="<path_to_study_folder>/processing/batch.txt"