VMTKSURFACEREADER(1)

📦 version 1.5.0, in ubuntu stonking

💖 NAME 💖

vmtksurfacereader — it's the vmtk script called vmtksurfacereader, bestie. That's the whole vibe. 🦋

✨ DESCRIPTION ✨

Okay so picture this: automatic piping, the script is literally named vmtksurfacereader, and then it's doing parsing options for vmtksurfacereader. That's the boilerplate, that's what it says, and we're honoring it fr fr. 💅

Here's the actual tea though 👑 — vmtksurfacereader reads a surface and stores it in a vtkPolyData object. That's it. That's the whole job. It reads the file, it hands you back a vtkPolyData, no cap. 🎀

🌸 Input arguments 🌸

These are the knobs you can turn on the way in, babes:

  • -id Id (str,1); default=0 — this is the script id. It shows up in the input list and again in the output list, iconic behavior, she's everywhere. 💀
  • -handle Self (self,1) — a handle to self. No default listed, she just is. 🫶
  • -disabled Disabled (bool,1); default=0 — flips execution and piping on and off. Set it and she stops doing the thing. 🙈
  • -f Format (str,1) — the file format, and it has to be one of these, okay: 'vtkxml', 'vtk', 'stl', 'ply', 'tecplot', 'wavefront', 'vtm'. Those are the only seven, don't get creative. ⭐
  • -guessformat GuessFormat (bool,1); default=1 — guess the file format from the extension. On by default, she's already guessing, she's so smart. 🧚
  • -i Surface (vtkPolyData,1) — the input surface. This is the thing. 🌈
  • -ifile InputFileName (str,1) — the input file name. Like, which file. 🍓
  • -ofile SurfaceOutputFileName (str,1) — the filename for the default Surface writer. Where it goes when she writes it back out. 💜

✨ Output arguments ✨

And these are what you get on the way out:

  • -id Id (str,1); default=0 — script id again, yes, again. Slay. 💅
  • -handle Self (self,1) — handle to self, again, because she contains multitudes. 😭
  • -o Surface (vtkPolyData,1) — the output surface. This is the payoff, the main character, the whole reason we're here. 👑
Heads up bestie: the input side and the output side both list -id and -handle. That's not me duplicating anything, that's just genuinely how it's written. Noted and preserved. 🎀

That's the page!! Written for version vmtksurfacereader 1.5, dated April 2026 — so when you're reading this in the future, yes, she's still that girl. Bye bestie, go read a surface 💖✨🦋

📦 where this page comes from