Using Workbench Command

Workbench Command is a set of command-line tools that can be used to perform simple and complex operations within Connectome Workbench.

Full Documentation:

Documentation Home
   To get the help information on a subcommand, run it without any additional
   arguments.  Options can occur in any position within the correct scope, and
   can have suboptions, which must occur within the scope of the option.  The
   easiest way to get this right is to specify options and arguments in the
   order they are listed.  As an example, consider this help information:

$ wb_command -volume-math
   wb_command -volume-math
      <expression> - the expression to evaluate, in quotes
      <volume-out> - output - the output volume

      [-fixnan] - replace NaN results with a value
         <replace> - value to replace NaN with

      [-var] (repeatable) - repeatable - a volume file to use as a variable
         <name> - the name of the variable, as used in the expression
         <volume> - the volume file to use as this variable

         [-subvolume] - select a single subvolume
            <subvol> - the subvolume number or name

         [-repeat] - reuse a single subvolume for each subvolume of calculation

   '<expression>' and '<volume-out>' denote mandatory parameters.  '[-fixnan]'
   denotes an option taking one mandatory parameter '<replace>', and
   '[-var] (repeatable)' denotes a repeatable option with mandatory parameters
   '<name>' and '<volume>', and two suboptions: '[-subvolume]', which has a
   mandatory parameter '<subvol>', and '[-repeat]', which takes no parameters.
   Commands also provide additional help info below the section in the example.
   Each option starts a new scope, and all options and arguments end any scope
   that they are not valid in.  For example, this command is correct:

$ wb_command -volume-math 'sin(x)' sin_x.nii.gz -fixnan 0 -var x x.nii.gz -subvolume 1

   as is this one (though less intuitive):

$ wb_command -volume-math -fixnan 0 'sin(x)' -var x -subvolume 1 x.nii.gz sin_x.nii.gz

   while this one is not, because the -fixnan option ends the scope of the -var
   option before all of its mandatory arguments are given:

$ wb_command -volume-math 'sin(x)' sin_x.nii.gz -var x -fixnan 0 x.nii.gz -subvolume 1

   and this one is incorrect because the -subvolume option occurs after the
   scope of the -var option has ended due to -fixnan:

$ wb_command -volume-math 'sin(x)' sin_x.nii.gz -var x x.nii.gz -fixnan 0 -subvolume 1

   and this one is similarly incorrect because the -subvolume option occurs
   after the scope of the -var option has ended due to the volume-out argument:

$ wb_command -volume-math 'sin(x)' -fixnan 0 -var x x.nii.gz sin_x.nii.gz -subvolume 1