Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

brainprep.interfaces.write_catbatch

brainprep.interfaces.write_catbatch(t1_files, output_dir, entities, model_long=1, dryrun=False)[source]

Generate CAT12 batch file.

Parameters:
t1_files: list[File]

Path to the T1 files.

output_dirDirectory

Working directory containing the outputs.

entitieslist[dict]

Dictionaries of parsed BIDS entities including modality for each input image file.

model_longint

Longitudinal model choice:1 short time (weeks), 2 long time (years) between images sessions. Default 1.

dryrunbool

If True, skip actual computation and file writing. Default False.

Returns:
batch_fileFile

Path to the ready for execution CAT12 batch file.

Notes

  • Input T1w image files are unzip in workspace folder.