average_images(1)

✨ average_images β€” NAME πŸ’–

okay so average_images is literally THE girl for averaging images πŸ’… β€” it's a CMTK tool (The Computational Morphology Toolkit, iykyk) and it eats a whole list of images for breakfast and hands you back the math-y version of them.


🌸 SYNOPSIS 🌸

average_images [options] image0 ...

like. you hand her a bunch of image0 ... files, you sprinkle options on top, she does her thing. so simple. so iconic. 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

bestie listen. this tool computes pixelwise average, variance, standard deviation, z-score, or entropy images from a list of intensity images you provide. that's it, that's the whole job, and she does it flawlessly no cap. ✨


πŸ‘‘ OPTIONS πŸ‘‘

πŸ’œ Global Toolkit Options (these are shared by all CMTK tools)

every CMTK tool gets these, they're like the group chat everyone's in:

  • --help β€” writes the list of basic command line options to standard output. your lil starter pack πŸŽ€
  • --help-all β€” writes the COMPLETE list of basic and advanced command line options to standard output. the full lore, the extended cut πŸ’€
  • --wiki β€” writes the list of command line options to standard output in MediaWiki markup. for the wiki girlies 🌈
  • --man β€” writes man page source in 'nroff' markup to standard output. yes, the very format you're reading rn, meta ik 😭
  • --version β€” writes the toolkit version to standard output. vibe check the version ✨
  • --echo β€” writes the current command line to standard output. she repeats you back, respectfully 🫢
  • --verbose-level <integer> β€” sets the verbosity level. pick a number, any number πŸ“’
  • --verbose, -v β€” increments the verbosity level by 1. > ⚠️ heads up: this one is deprecated; it's only supported for backward compatibility. she's still here for you but she's lowkey retired πŸ’€
  • --threads <integer> β€” sets the maximum number of parallel threads (for POSIX threads and OpenMP). more threads = more chaos = go faster πŸ”₯

🌸 Main Options 🌸

  • --mode β€” the mode of averaging operation. supported values: "avg", "var", "stdev", "zscore", "entropy", where the default is "avg". or, alternatively, just use one of these cuties:
    • --avg β€” compute average (i.e., mean) image. [This is the default] ✨
    • --var β€” compute variance image.
    • --stdev β€” compute standard deviation image.
    • --zscore β€” compute z-score image.
    • --entropy β€” compute pixel-by-pixel population entropy image. the chaotic one, obsessed πŸŒ€

πŸŽ€ Data Preprocessing πŸŽ€

get your data cute before she averages it:

  • --log, -l β€” apply log to input data. math-ify it first πŸ“
  • --abs, -a β€” use absolute input values. no negatives allowed, periodt βœ‹
  • --normalize-mean-stdev, -n β€” normalize image intensities using means and standard deviations. gets everyone on the same playing field πŸ’…
  • --set-padding-value <double> β€” define padding value in input images. [Default: disabled] β€” so by default there's no padding value set at all, fr fr πŸ«₯

πŸ’– Output Options πŸ’–

  • --outfile-name <string>, -o <string> β€” output file name. [Default: average.nii ]
  • --type β€” scalar data type of output image. supported values: "float", "double", where the default is "float". or use one of these:
    • --float β€” single-precision float. [This is the default] ✨
    • --double β€” double-precision float. she's extra precise, she's built different πŸ‘‘

🫢 AUTHORS 🫢

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

tag yourself, I'm the entire contributor list πŸ’œ


πŸ“œ LICENSE πŸ“œ

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


πŸ› BUGS πŸ›

found a bug? report bugs at http://nitrc.org/projects/cmtk/ β€” do NOT suffer in silence bestie, tell the devs 😭


🌟 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 thing πŸ’– go average some images, you absolute icon, I'm so proud of you 🫢✨

this has been your girl from CMTK 3.3.1p2, dated Jun 24 2026, signing off β€” slay, bye πŸ‘‘πŸ’…

πŸ“¦ where this page comes from