VMTKPETERSURFACECLIPPER(1)

💖 NAME 💖

vmtkpetersurfaceclipper — literally the vmtk script called vmtkpetersurfaceclipper, no notes. It's a User Command, it lives in section 1 of the manual, and it's about to eat.

✨ DESCRIPTION ✨

Okay so bestie, real talk: this is a vmtk script, and the vibe is automatic piping. Also it's doing some parsing options business. That's the whole trailer, we're not gonna overthink it. 🫶

Here's the actual tea though: petersurfaceclipper lets you interactively clip a surface with a box. Iconic behavior. 💅

🎀 Input arguments 🎀

• -id Id (str,1); default=0 — the script id, babes. Defaults to 0.
• -handle Self (self,1) — a handle to self. Yes, it's giving main character energy, it's literally handing you itself.
• -disabled Disabled (bool,1); default=0 — flip this and you disable execution and piping. Default is 0, so by default it's alive and thriving.
• -i Surface (vtkPolyData,1) — the input surface. This is the thing we're clipping, bestie.
• -ifile SurfaceInputFileName (str,1) — filename for the default Surface reader.
• -iclip ClipsIn (vtkMultiBlockDataSet,1) — the input clips file.
• -iclipfile ClipsInInputFileName (str,1) — filename for the default ClipsIn reader.
• -type WidgetType (str,1) in ['box', 'sphere']; default=box — what kind of widget we're clipping with. You get 'box' or 'sphere'. Default is box. Pick your fighter. 🦋
• -transform Transform (vtkTransform,1) — the widget transform. Super useful in case of piping of multiple clipping scripts, iykyk.
• -cleanoutput CleanOutput (bool,1); default=1 — toggle cleaning the unused points. Default 1, so it's tidy by default. ✨
• -insideout InsideOut (bool,1); default=0 — toggle switching output and clipped surfaces. Default 0.
• -interactive Interactive (bool,1); default=1 — toggle clipping with a widget or with a pre-defined scalar field. Default 1 (widget mode, live and direct).
• -array ClipArrayName (str,1); default=None — name of the array to clip with in case of non-interactive clipping. Default is None, so bring your own array.
• -value ClipValue (float,1); default=0.0 — the scalar value at which to perform the clipping in case of non-interactive clipping. Default 0.0.
• -renderer vmtkRenderer (vmtkRenderer,1) — an external renderer, if you got one.
• -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.
• -oclipfile ClipsOutOutputFileName (str,1) — filename for the default ClipsOut writer.

🌸 Output arguments 🌸

• -id Id (str,1); default=0 — the script id again, because yes, and default is 0.
• -handle Self (self,1) — handle to self. Still the moment. 💜
• -o Surface (vtkPolyData,1) — the output surface.
• -oclipped ClippedSurface (vtkPolyData,1) — the clipped surface.
• -ocutlines CutLines (vtkPolyData,1) — the cutlines, the lil edges where the cutting happened.
• -oclip ClipsOut (vtkMultiBlockDataSet,-1) — the output surfaces associated with the clips made.
• -otransform Transform (vtkTransform,1) — the output widget transform.

fr fr, when you're piping these together, -transform and -otransform are the ones that keep your multiple clipping scripts from falling apart. no cap. 💀

And that's the whole page, bestie, we ate. 🍓 This was vmtkpetersurfaceclipper version 1.5, dated April 2026, from the User Commands corner of the manual — VMTKPETERSURFACECLIPPER (1). Go clip something cute. 👑