VMTKBRANCHCLIPPER(1)

💖 NAME 💖

So like, this is the manual page for vmtkbranchclipper — yeah, that's a whole mouthful — and it's here to tell you that vmtkbranchclipper is a vmtk script. That's the vibe. The manual's own name is VMTKBRANCHCLIPPER(1) and it lives in the User Commands section, just so you know where you are. 🎀

---

✨ DESCRIPTION ✨

Okay so boom, here's the whole tea: Automatic piping vmtkbranchclipper Parsing options vmtkbranchclipper. Yeah, that's literally what the page says, I'm not even joking, that's the script being an icon and announcing itself. 💅

And then the actual point of the whole thing:

vmtkbranchclipper : divide a surface in relation to its split and grouped centerlines

That's it. That's the mission. Surface goes in, surface gets chopped up according to its split + grouped centerlines. Iconic behavior honestly. 🌈

---

🫶 Input arguments:

Okay bestie, this is the long list, but it's not scary, it's just thorough. Every single one of these is here, no skipping, no cap:

• -id Id (str,1); default=0 — script id. Yeah it's the script's little nametag. 🙈
• -handle Self (self,1) — handle to self. It's holding its own hand, cute.
• -disabled Disabled (bool,1); default=0 — disable execution and piping. Flip this and it just… does nothing. Respect.
• -i Surface (vtkPolyData,1) — the surface. The main character, literally. 👑
• -ifile SurfaceInputFileName (str,1) — filename for the default Surface reader. So it knows where to read your surface from. 📂
• -centerlines Centerlines (vtkPolyData,1) — the centerlines. The other main character. 👑
• -centerlinesfile CenterlinesInputFileName (str,1) — filename for the default Centerlines reader.
• -groupidsarray GroupIdsArrayName (str,1); default=GroupIds — the name of the group ids array.
• -groupids GroupIds (int,-1); default=[] — the group ids themselves. Empty list by default, come on, give it something. 💀
• -insideout InsideOut (bool,1); default=0 — flip it and everything's inside out, like your brain at 3am.
• -useradius UseRadiusInformation (bool,1); default=1 — yep, use that radius info, it's on by default, slay.
• -radiusarray RadiusArrayName (str,1); default=MaximumInscribedSphereRadius — the radius array's name. Yes, that whole long name is the default. 🍓
• -blankingarray BlankingArrayName (str,1); default=Blanking — the blanking array's name.
• -cutoffradiusfactor CutoffRadiusFactor (float,1) >= 0.0; default=1e+16 — has to be >= 0.0, and defaults to an absolutely feral 1e+16. She's big. 😭
• -clipvalue ClipValue (float,1); default=0.0 — the clip value. Zero by default, neutral queen. ✨
• -interactive Interactive (bool,1); default=0 — turn on interactive mode if you wanna poke at it live.
• -renderer vmtkRenderer (vmtkRenderer,1) — external renderer. Bring your own, iykyk.
• -ofile SurfaceOutputFileName (str,1) — filename for the default Surface writer.
• -ocenterlinesfile CenterlinesOutputFileName (str,1) — filename for the default Centerlines writer.

---

🦋 Output arguments:

Now the part where it gives you stuff back. Not me being excited about return values but like, here we are:

• -id Id (str,1); default=0 — script id. Yeah it's here twice, in and out, she contains multitudes.
• -handle Self (self,1) — handle to self. Again. Self-love fr fr. 💜
• -o Surface (vtkPolyData,1) — boom, your surface, processed and delivered. 🔥
• -ocenterlines Centerlines (vtkPolyData,1) — and your centerlines too, matching set, adorable.

Heads up bestie: this page doesn't hand you extra examples, exit statuses, environment variables or SEE ALSO references — what you see up there is the whole plate, so I'm not gonna invent any at you. No fake facts on my watch. 💅

---

Okay that's the whole page, you understood all of it, I'm so proud of you. This lil manual belongs to vmtkbranchclipper version 1.5, dated April 2026 — shoutout to the version number and the date, you did amazing sweetie 🎀✨🫶