.TH sympl "1" "Jan 25 2019" "CMTK 3.3.1p1" "The Computational Morphometry Toolkit"
.SH NAME
sympl \- Symmetry plane computation
.SH SYNOPSIS
\fBsympl\fR InputImage 
.SH DESCRIPTION
Compute the approximate symmetry plane of an image to determine, for example, the mid-sagittal plane in human brain images. Various forms of output are supported, e.g., writing the input image with the symmetry plane drawn into it, or the input image realigned along the symmetry plane.
.SH OPTIONS
.SS Global Toolkit Options (these are shared by all CMTK tools)
.TP 5
\fB\-\-help\fR
Write list of basic command line options to standard output.
.TP 5
\fB\-\-help-all\fR
Write complete list of basic and advanced command line options to standard output.
.TP 5
\fB\-\-wiki\fR
Write list of command line options to standard output in MediaWiki markup.
.TP 5
\fB\-\-man\fR
Write man page source in 'nroff' markup to standard output.
.TP 5
\fB\-\-xml\fR
Write command line syntax specification in XML markup (for Slicer integration).
.TP 5
\fB\-\-version\fR
Write toolkit version to standard output.
.TP 5
\fB\-\-echo\fR
Write the current command line to standard output.
.TP 5
\fB\-\-verbose-level\fR \fI<integer>\fR
Set verbosity level.
.TP 5
\fB\-\-verbose\fR, \fB\-v\fR
Increment verbosity level by 1 (deprecated; supported for backward compatibility).
.TP 5
\fB\-\-threads\fR \fI<integer>\fR
Set maximum number of parallel threads (for POSIX threads and OpenMP).
.SS Optimization
.TP 5
\fB\-\-accuracy\fR \fI<double>\fR, \fB\-a\fR \fI<double>\fR
Accuracy (final optimization step size in [mm].
.B [Default: 0.1]
.TP 5
\fB\-\-sampling\fR \fI<double>\fR, \fB\-s\fR \fI<double>\fR
Resampled image resolution. This is the resolution [in mm] of the first (finest) resampled image in the multi-scale pyramid, which is derived directly from the original full-resolution images.
.B [Default: 1]
.TP 5
\fB\-\-levels\fR \fI<integer>\fR, \fB\-l\fR \fI<integer>\fR
Number of resolution levels. The algorithm will create (levels-1) resampled images with increasingly coarse resolution and use these in successive order of increasing resolution before using the original images at the final level.
.B [Default: 4]
.SS Initial approximate symmetry plane orientation
.TP 5
\fB\-\-initial-plane\fR
Initial orientation of symmetry plane. This should be the closest orthogonal plane to the expected actual symmetry plane.
Supported values: "initial-axial", "initial-coronal", "initial-sagittal", "initial-xy", "initial-xz", "initial-yz", where the default is "initial-sagittal", or use one of the following:
.RS 5
.TP 5
\fB\-\-initial-axial\fR
Approximately axial symmetry
.TP 5
\fB\-\-initial-coronal\fR
Approximately coronal symmetry
.TP 5
\fB\-\-initial-sagittal\fR
Approximately sagittal symmetry
\fB[This is the default]\fR
.TP 5
\fB\-\-initial-xy\fR
Approximately XY plane symmetry
.TP 5
\fB\-\-initial-xz\fR
Approximately XZ plane symmetry
.TP 5
\fB\-\-initial-yz\fR
Approximately YZ plane symmetry
\fB[This is the default]\fR
.RE
.SS Pre-computed symmetry
.TP 5
\fB\-\-output-only\fR \fI<string>\fR
Give symmetry parameters [Rho Theta Phi] as option, skip search.
.B [Default: disabled]
.TP 5
\fB\-\-output-only-file\fR \fI<string>\fR
Read symmetry parameters from file, skip search.
.B [Default: disabled]
.SS Data pre-processing
.TP 5
\fB\-\-min-value\fR \fI<float>\fR
Force minumum data value.
.B [Default: disabled]
.TP 5
\fB\-\-max-value\fR \fI<float>\fR
Force maximum data value.
.B [Default: disabled]
.SS Output of Images
.TP 5
\fB\-\-interpolation\fR
Interpolation method used for reformatted output data
Supported values: "linear", "cubic", "sinc", where the default is "linear", or use one of the following:
.RS 5
.TP 5
\fB\-\-linear\fR, \fB\-L\fR
Use linear image interpolation for output.
\fB[This is the default]\fR
.TP 5
\fB\-\-cubic\fR, \fB\-C\fR
Use cubic image interpolation for output.
.TP 5
\fB\-\-sinc\fR, \fB\-S\fR
Use cosine-windowed sinc image interpolation for output.
.RE
.TP 5
\fB\-\-pad-out\fR \fI<double>\fR, \fB\-P\fR \fI<double>\fR
Padding value for output images.
.B [Default: disabled]
.TP 5
\fB\-\-mark-value\fR \fI<double>\fR
Data value to mark (draw) symmetry plane.
.B [Default: 4095]
.TP 5
\fB\-\-write-marked\fR \fI<image-path>\fR
File name for output image with marked symmetry plane.
.B [Default: NONE]
.TP 5
\fB\-\-write-aligned\fR \fI<image-path>\fR
File name for symmetry plane-aligned output image.
.B [Default: NONE]
.TP 5
\fB\-\-mark-aligned\fR
Mark symmetry plane in aligned output image.
.TP 5
\fB\-\-write-subtract\fR \fI<image-path>\fR
File name for mirror subtraction image.
.B [Default: NONE]
.TP 5
\fB\-\-write-mirror\fR \fI<image-path>\fR
File name for image mirrored w.r.t. symmetry plane.
.B [Default: NONE]
.SS Output of Parameters
.TP 5
\fB\-\-outfile\fR \fI<path>\fR, \fB\-o\fR \fI<path>\fR
File name for symmetry plane parameter output.
.B [Default: NONE]
.TP 5
\fB\-\-write-xform\fR \fI<transformation-path>\fR
Write affine alignment transformation to file
.B [Default: NONE]
.SH AUTHORS
Torsten Rohlfing, with contributions from Michael P. Hasak, Greg Jefferis, Calvin R. Maurer, Daniel B. Russakoff, and Yaroslav Halchenko
.SH LICENSE
http://www.fsf.org/licensing/licenses/gpl.html
.SH BUGS
Report bugs at http://nitrc.org/projects/cmtk/
.SH ACKNOWLEDGMENTS
CMTK is developed with support from the NIAAA under Grant AA021697, National Consortium on Alcohol and Neurodevelopment in Adolescence (N-CANDA): Data Integration Component. From April 2009 through September 2011, CMTK development and maintenance was supported by the NIBIB under Grant EB008381.