mcwarp(1)

πŸ’– mcwarp(1) πŸ’–

okay bestie, welcome to mcwarp(1), a.k.a. The Computational Morphometry Toolkit's own multi-channel nonrigid registration icon ✨ she lives in the CMTK family, and no cap, she's a lot β€” but we're gonna get through it together 🫢


✨ NAME ✨

mcwarp β€” Multi-channel nonrigid registration πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

mcwarp [options] mcaffineOutput

like… yes, that's the whole vibe. one required-ish thingy, and a whole buffet of options 🌸


πŸ¦‹ DESCRIPTION πŸ¦‹

Multi-channel nonrigid B-spline image registration using histogram-based or covariance-based joint entropy measures πŸ”₯

that's the actual job, fr fr. she aligns images with B-splines, she does it nonrigidly, and she can juggle multiple channels at once. her measure of "how good is this alignment" is either histograms or covariance β€” you get to pick, main character energy πŸ‘‘


πŸ’… OPTIONS πŸ’…

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

these are the group-chat-wide settings, every CMTK tool got them, not just our girl:

  • --help β€” Write list of basic command line options to standard output.
  • --help-all β€” Write complete list of basic and advanced command line options to standard output. (the full lore drop πŸ“š)
  • --wiki β€” Write list of command line options to standard output in MediaWiki markup.
  • --man β€” Write man page source in 'nroff' markup to standard output.
  • --version β€” Write toolkit version to standard output.
  • --echo β€” Write the current command line to standard output.
  • --verbose-level <integer> β€” Set verbosity level.
  • --verbose, -v β€” Increment verbosity level by 1 (deprecated; supported for backward compatibility). yep, deprecated, but she's still here for the old heads πŸ™ˆ
  • --threads <integer> β€” Set maximum number of parallel threads (for POSIX threads and OpenMP). parallelize her, she eats πŸ’€

πŸ‘‘ Main Options

this is the good part. the actual levers. the real ones.

  • --out-archive <string>, -o <string> β€” Output archive path. [Default: NONE]
  • --downsample-from <integer>, -d <integer> β€” Initial downsampling factor [1]. [Default: 1]
  • --downsample-to <integer>, -D <integer> β€” Final downsampling factor [1]. [Default: 1]
  • --downsample-average <boolean> β€” Downsample using sliding-window averaging [default: off] ) [Default: 0]
  • --smooth <float> β€” Sigma of Gaussian smoothing kernel in multiples of template image pixel size [default: off] ) [Default: 0]
  • --grid-spacing <double> β€” Initial control point grid spacing in mm. [Default: 40]
  • --grid-spacing-exact <double> β€” Exact initial grid spacing, even if it doesn't match image FOV. [Default: disabled]
  • --refine-grid <integer> β€” Number of control point grid refinements. [Default: 0]
  • --delay-refine-grid β€” Delay control point grid refinement until after pixel refinement.
  • --adaptive-fix-thresh-factor <float> β€” Intensity threshold factor [0..1] for adaptive parameter fixing. [default: 0 -- no fixing] [Default: 0]
  • --adaptive-fix-thresh-factor-entropy <float> β€” Entropy threshold factor [0..1] for adaptive parameter fixing. [default: 0 -- no fixing] [Default: disabled]
  • --fix-warp-x β€” Fix transformation (do not warp) in x-direction.
  • --fix-warp-y β€” Fix transformation (do not warp) in y-direction.
  • --fix-warp-z β€” Fix transformation (do not warp) in z-direction.
  • --jacobian-constraint-weight <float> β€” Weight for Jacobian volume preservation constraint [Default: 0]
  • --histograms, -H β€” Use multi-dimensional histograms to compute entropies [default. [This is the default]
  • --covariance, -C β€” Use covariance matrix determinants to compute entropies.
  • --cubic, -c β€” Use cubic interpolation [default: linear]
  • --mi β€” Use standard mutual information metric [default] [This is the default]
  • --nmi β€” Use normalized mutual information metric
  • --intensity-correction, -I β€” Correct image intensities using local transformation Jacobian to preserve total signal
  • --initial-step-size <double> β€” Initial optimizer step size in pixels. [Default: 1]
  • --final-step-size <double> β€” Initial optimizer step size in pixels. [Default: 0.125]
  • --delta-f-threshold <double> β€” Optional threshold to terminate optimization (level) if relative change of target function drops below this value. [Default: 0]

🫢 AUTHORS 🫢

Torsten Rohlfing, with contributions from Michael P. Hasak, Greg Jefferis, Calvin R. Maurer, Daniel B. Russakoff, and Yaroslav Halchenko

the whole squad ate, no crumbs 🌟


πŸ’œ LICENSE πŸ’œ

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

😭 BUGS 😭

Report bugs at http://nitrc.org/projects/cmtk/

not me making you file a bug report… but if she's acting up, that's the link, bestie πŸ™ˆ


🌸 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.


and that's the whole page, periodt πŸ’– this was CMTK 3.3.1p2, dated Jun 24 2026 β€” she's giving "still thriving" and we're obsessed πŸ‘‘βœ¨ go register something, you got this πŸ¦‹

πŸ“¦ where this page comes from