USAGE:(1)

πŸ“¦
version 0.3 Β· 2 versions
, in fedora 43

πŸ’– NAME πŸ’–

okay so bestie, the manual name here is literally usage: β€” no cap, that's just what it's called 🫢 β€” and this whole page is the manual page for usage: tff_visualize_overlap [-h] [--remove_invalid] IN_TRACTOGRAM reference. yes the manpage name is a whole command line, she's extra like that, we love her πŸ’…


✨ DESCRIPTION ✨

so like, the actual invocation is:

usage: tff_visualize_overlap [-h] [--remove_invalid] IN_TRACTOGRAM reference

and what she DOES, bestie, is display a tractogram and its density map (that map is computed from Dipy, iykyk) in rasmm, voxmm and vox space β€” with its bounding box, obviously, because we're not animals πŸŽ€

that's the whole vibe. three spaces, one bounding box, one density map. iconic behavior fr fr ✨


🧚 positional arguments 🧚

these are the ones you HAVE to give her, no skipping:

  • IN_TRACTOGRAM β€” the tractogram filename, periodt. the format has to be one of trk, tck, vtk, fib, dpy, trx β€” that's the whole guest list, nobody else gets in πŸ™ˆ
  • reference β€” the reference anatomy that makes tck/vtk/fib/dpy file support work. it's gotta be nii or nii.gz πŸ’œ

πŸ’… options πŸ’…

the lil switches, she has two, she keeps it simple:

  • -h, --help β€” show this help message and exit. the classic. the "wait what does this do again" button 🌸
  • --remove_invalid β€” removes invalid streamlines so the density_mapfunction doesn't crash on you 😭 genuinely useful, because crashing mid-plot is not the main character energy we're going for πŸ‘‘

πŸ’€ when you forget the arguments πŸ’€

if you run her with nothing, she will simply say:

tff_visualize_overlap: error: the following arguments are required: IN_TRACTOGRAM, reference
not a vibe check you want to fail, bestie. give her both positional args, every single time 🫢

that's the whole page, you ate it, go visualize some tractograms πŸ’–βœ¨πŸŽ€

and for the cute sign-off: this one's dated September 2025 β€” that's the version/date on the footer, so if you're reading this way later, hi from the past, hope your streamlines are valid πŸ¦‹β­

πŸ“¦ where this page comes from