create_transmit_bias_voltages_file

qx_utilities.hcp.create_transmit_bias_voltages_file.create_transmit_bias_voltages_file(sessions, options, overwrite=True, thread=0)

create_transmit_bias_voltages_file [... processing options]

Create the transmit bias voltages file for a group of sessions.

Reads the TxRefAmp value from each session's unprocessed rfMRI_REST1_AP JSON sidecar and writes one value per line, in session order, to the file given by --hcp_voltages. The HCP transmit bias phase 4 pipeline (hcp_transmit_bias_group_average_corrected_maps) consumes this file, and creates it itself when it is missing -- this command lets you generate and inspect it up front.

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.

--hcp_suffix (str, default ''):

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

--hcp_voltages (str, default ''):

Path of the voltages file to create. Mandatory.

--logfolder (str, default ''):

The path to the folder where logs are to be stored, if other than default.

Output files

The voltages file at the path given by --hcp_voltages, holding one TxRefAmp value per line in session order.

Examples

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