VMTKSURFACETOBINARYIMAGE(1)

💖 NAME 💖

vmtksurfacetobinaryimage — bestie, it's the vmtk script vmtksurfacetobinaryimage, and yes the name is a whole mouthful, we love her anyway 🫶

✨ DESCRIPTION ✨

okay so first things first, the vibes: this script does automatic piping for vmtksurfacetobinaryimage and it's also busy parsing options, all on its own, main character energy fr fr. Then:

vmtksurfacetobinaryimage : Convert a surface to a binary image mask

where voxels are labeled if they lie inside the surface or not. Like, that's the whole gig 💅

📥 Input arguments

these are the things you can hand her on the way in 🌸

• -id Id (str,1); default=0 — the script id. it's giving "who am I" but for scripts.
• -handle Self (self,1) — a handle to self. self-love, literally 💖
• -disabled Disabled (bool,1); default=0 — turns execution and piping OFF. set it and she simply will not run, no cap.
• -i Surface (vtkPolyData,1) — the input surface. the star of the show 👑
• -ifile SurfaceInputFileName (str,1) — filename for the default Surface reader. so you can just point her at a file bestie.
• -invalue InsideValue (int,1) >= 0 and <= 255; default=1 — the value used to label voxels which contain points inside the surface.
• -outvalue OutsideValue (int,1) >= 0 and <= 255; default=0 — the value to label voxels which contain points inside the surface. (yes, that's literally what the manpage says, I'm not editing her words, only reporting them 🙈)
• -imagespacing PolyDataToImageDataSpacing (float,3) >= 0.0; default=[0.3, 0.3, 0.3] — the sample spacing for the polydata to image data conversion. three floats, three chances to slay.
• -ofile ImageOutputFileName (str,1) — filename for the default Image writer. where the glow-up gets saved ✨

📤 Output arguments

and these are what she gives you back, iconic behavior:

• -id Id (str,1); default=0 — script id, again, because consistency is a vibe.
• -handle Self (self,1) — handle to self. still self-love.
• -o Image (vtkImageData,1) — the binary surface image. the moment we've all been waiting for 🎀

heads up bestie: -invalue and -outvalue are both strictly in the 0–255 range and -imagespacing has to be >= 0.0. no negative spacing, we do not do that here 🦋

omg and a lil sign-off to close the loop: this is vmtksurfacetobinaryimage version 1.5, dated April 2026. periodt 💜