symplx(1)

📦
version 3.3.1p2 · 7 versions
, in ubuntu stonking

💖 symplx(1) — the manual page, but your bestie is explaining it 💖

okay so listen. this is the manual page for symplx, part of the Computational Morphology Toolkit, aka CMTK. it's giving brain-science, it's giving geometry, it's giving main character energy. buckle up bestie 🎀

✨ NAME ✨

symplx — symmetry plane computation 🦋

🌸 SYNOPSIS 🌸

symplx InputImage

literally that's it. hand it an image and it will find the plane of symmetry. slay.

💅 DESCRIPTION 💅

So symplx computes the approximate symmetry plane of an image. why do you care?? because you can use it to figure out, for example, the mid-sagittal plane in human brain images. iconic.

and there are various forms of output, no cap. like:

  • writing the input image with the symmetry plane drawn into it
  • the input image realigned along the symmetry plane

whatever your little heart desires 💖

🎀 OPTIONS 🎀

⭐ Global Toolkit Options (these are shared by all CMTK tools)

  • --help — writes the list of basic command line options to standard output. baby's first help flag 🍼
  • --help-all — writes the complete list of basic AND advanced command line options to standard output. the whole lore.
  • --wiki — writes the list of command line options to standard output in MediaWiki markup.
  • --man — writes man page source in nroff markup to standard output.
  • --xml — writes command line syntax specification in XML markup (this one's for Slicer integration).
  • --version — writes toolkit version to standard output.
  • --echo — writes the current command line to standard output.
  • --verbose-level <integer> — set verbosity level.
  • --verbose, -v — increment verbosity level by 1. > ⚠️ this one is deprecated, it's only supported for backward compatibility. still here, still cute, just don't build your whole personality on it.
  • --threads <integer> — set maximum number of parallel threads (for POSIX threads and OpenMP). go fast, but not too fast 🏃‍♀️

🔥 Optimization

  • --accuracy <double>, -a <double> — accuracy (final optimization step size) in [mm]. [Default: 0.1]
  • --sampling <double>, -s <double> — 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. [Default: 1]
  • --levels <integer>, -l <integer> — 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. [Default: 4]
  • --fix-offset — fix symmetry plane offset. this reduces computation time and forces the symmetry plane to cross the center of mass, but it may lead to a less-than-accurate result. > bestie, read that again: faster and constrained, but less-than-accurate. cute but risky 🙈

🧚 Initial approximate symmetry plane orientation

  • --initial-plane — 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". orrrr use one of these instead:
    • --initial-axial — approximately axial symmetry
    • --initial-coronal — approximately coronal symmetry
    • --initial-sagittal — approximately sagittal symmetry [This is the default]
    • --initial-xy — approximately XY plane symmetry
    • --initial-xz — approximately XZ plane symmetry
    • --initial-yz — approximately YZ plane symmetry [This is the default]

👑 Pre-computed symmetry

  • --output-only <string> — give symmetry parameters [Rho Theta Phi] as an option, skip the search. [Default: disabled]
  • --output-only-file <string> — read symmetry parameters from file, skip the search. [Default: disabled]

🍓 Data pre-processing

  • --min-value <float> — force minumum data value. [Default: disabled]
  • --max-value <float> — force maximum data value. [Default: disabled]

🌈 Output of Images

  • --interpolation — interpolation method used for reformatted output data. supported values: "linear", "cubic", "sinc", where the default is "linear". or use one of the following:
    • --linear, -L — use linear image interpolation for output. [This is the default]
    • --cubic, -C — use cubic image interpolation for output.
    • --sinc, -S — use cosine-windowed sinc image interpolation for output.
  • --pad-out <double>, -P <double> — padding value for output images. [Default: disabled]
  • --mark-value <double> — data value to mark (draw) the symmetry plane. [Default: 4095]
  • --write-marked <image-path> — file name for output image with marked symmetry plane. [Default: NONE]
  • --write-aligned <image-path> — file name for symmetry plane-aligned output image. [Default: NONE]
  • --mark-aligned — mark symmetry plane in aligned output image.
  • --write-subtract <image-path> — file name for mirror subtraction image. [Default: NONE]
  • --write-mirror <image-path> — file name for image mirrored w.r.t. symmetry plane. [Default: NONE]

💜 Output of Parameters

  • --outfile <path>, -o <path> — file name for symmetry plane parameter output. [Default: NONE]
  • --write-xform <transformation-path> — write affine alignment transformation to file. [Default: NONE]

🌟 AUTHORS 🌟

Torsten Rohlfing, with contributions from Michael P. Hasak, Greg Jefferis, Calvin R. Maurer, Daniel B. Russakoff, and Yaroslav Halchenko. a whole squad, we love a collaborative era 🫶

📜 LICENSE 📜

http://www.fsf.org/licensing/licenses/gpl.html

💀 BUGS 💀

report bugs at http://nitrc.org/projects/cmtk/. not me gatekeeping bug reports, go tell them fr fr 😭

🎀 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. funding lore, honestly iconic 💖

and that's the whole page, bestie ✨ this was symplx(1) from CMTK 3.3.1p2, dated Jun 24 2026 — go find yourself a symmetry plane, you absolute queen 👑💅🦋

📦 where this page comes from