Surface Warp Protocol Serial Usage
Overview
This page describes how to use Surface Warp protocol on the command-line in serial. This implementation is useful when running the protocol locally when no parallelization resources are available. This documentation applies to both the Dual Surface Warp protocol and the Octahedral Surface Warp Protocol, and any differences are noted.
Use
Here are general steps to take in running the protocol:
- Organize the data according to the common file structure
- Execute the script 'serial_process_all.sh', specifying the protocol directory, the subject directory list, atlas directory and log directory.
The reference copy of 'serial_process_all.sh" is in the directory: /nethome/users/shapetls/bin/SurfaceWarpTools/scripts/serial
An example of calling the above script is here.
If the user has a precomputed atlas, that directory should be passed to the 'serial_process_all.sh' script. Otherwise, the atlas will be computed.
Optionally, the user may perform the steps of the protocol with a greater degree of control. The user may flatten a single subject in serial or directory of subjects in serial. Given a collection of subjects with flattened data, the user may compute an atlas. Given an atlas and a subject with flattened data the user may warp that subject to the atlas in serial or warp a directory of subjects with flattened data to a given atlas in serial.
Scripts
The following is an enumeration of the scripts, with a brief description of each. See the scripts' comments for a more information. These scripts require the user to provide the directory containing the protocol scripts, whether they are dual or octahedral. This directory is referred to as the "protocol directory".
- serial_process_all.sh:
- This script takes a protocol directory, a subject directory list and an atlas directory as input. The script flattens all subjects in the study directory list. If the given atlas directory does not exist, then the atlas is computed. Otherwise, the existing atlas data is used. Then, all subjects in the study directory are warped to the atlas. This is the "master" script for the process, and it calls all other scripts as necessary.
- serial_flatten_all.sh
- This scripts takes a protocol directory and a subject directory list as input. The script applies the "flatten_subject.sh" script to all subjects in the study directory list.
- serial_warp_all.sh:
- This script takes a subject directory list and an atlas directory as input. The script then applies the "warp_subject.sh" script to all subjects in the subject list.
- serial_constants.sh
- This script defines the constant values used in the serial processing scripts. All other scripts "source" this script.
Filenames and Parameters
See the page on implementation for specific filenames and algorithm parameters.