VMTKSURFACECLIPPER(1)

💅 NAME 💅

okay so bestie, meet vmtksurfaceclipper — the vmtk script vmtksurfaceclipper. that's it, that's the name, we're starting strong 🫶

✨ DESCRIPTION ✨

Automatic piping vmtksurfaceclipper. Parsing options vmtksurfaceclipper. (yes, that's literally what it does under the hood, it's giving very "the code explains itself" energy 😭)

vmtksurfaceclipper — interactively clip a surface with a box. iconic behavior honestly 💖

📥 Input arguments 🎀

• -id Id (str,1); default=0 — script id, it's the little name tag your script wears ✨
• -handle Self (self,1) — handle to self, aka a lil handshake back to the object itself 🫶
• -disabled Disabled (bool,1); default=0 — disable execution and piping. flip it and the whole thing just… doesn't 💀
• -i Surface (vtkPolyData,1) — the input surface, the main character of this whole operation 👑
• -ifile SurfaceInputFileName (str,1) — filename for the default Surface reader, so it knows where to look 👀
• -type WidgetType (str,1) in ['box', 'sphere']; default=box — type of widget used for clipping. box or sphere, pick your fighter 🥊
• -transform Transform (vtkTransform,1) — the widget transform, useful in case of piping of multiple clipping scripts. lowkey the MVP when you're chaining stuff 🔥
• -cleanoutput CleanOutput (bool,1); default=1 — toggle cleaning the unused points. bye bye stray points, no crumbs left 🧹✨
• -insideout InsideOut (bool,1); default=0 — toggle switching output and clipped surfaces, it flips the whole vibe upside down 🙃
• -interactive Interactive (bool,1); default=1 — toggle clipping with a widget or with a pre-defined scalar field. widget mode vs scalar mode, choose your destiny 🌈
• -array ClipArrayName (str,1); default=None — name of the array with which to clip in case of non-interactive clipping 📛
• -value ClipValue (float,1); default=0.0 — scalar value at which to perform clipping in case of non-interactive clipping 🎯
• -renderer vmtkRenderer (vmtkRenderer,1) — external renderer, for when you already have one and don't need a new one, we love a reuse moment ♻️
• -ofile SurfaceOutputFileName (str,1) — filename for the default Surface writer 💾
• -oclippedfile ClippedSurfaceOutputFileName (str,1) — filename for the default ClippedSurface writer ✂️
• -ocutlinesfile CutLinesOutputFileName (str,1) — filename for the default CutLines writer 📝

no cap, that's every single input flag. count them. all sixteen. i checked twice bestie 🫡

📤 Output arguments 💜

• -id Id (str,1); default=0 — script id, same lil name tag energy ✨
• -handle Self (self,1) — handle to self 🫶
• -o Surface (vtkPolyData,1) — the output surface, freshly clipped and gorgeous 🌸
• -oclipped ClippedSurface (vtkPolyData,1) — the clipped surface, the part that got yeeted off ✂️
• -ocutlines CutLines (vtkPolyData,1) — the cutlines, the lil scar where the cut happened 💅
• -otransform Transform (vtkTransform,1) — the output widget transform, so you can carry that placement onward 🔥

fr fr that's the whole page, nothing skipped, nothing invented, facts fully intact 🧚

this was vmtksurfaceclipper version 1.5 from April 2026, floating around in the User Commands section of the manual. periodt. 💖✨🎀