VMTKPOTENTIALFIT(1)

📦 version 1.5.0, in ubuntu stonking

✨ VMTKPOTENTIALFIT ✨

okay bestie, welcome to vmtkpotentialfit, a section 1 user command from the vmtk fam 💖 (yes, that's the name, and yes we're spelling it right every single time, no cap).

🌸 NAME 🌸

vmtkpotentialfit — it's a vmtk script, babes. literally the script vmtkpotentialfit. that's the whole name. periodt. 💅

🦋 DESCRIPTION 🦋

So here's the vibe: automatic piping vmtkpotentialfit, and then parsing options vmtkpotentialfit. that's just how this script rolls, she's an overachiever. 🫶

vmtkpotentialfit : it's an explicitly deformable model which evolves a surface so it lands on the gradient magnitudes of an input image ✨ (yes, that's a whole mouthful, but that's the one thing it does and it does it well).

👑 Input arguments 👑

okay so these are the things you feed her, in order, bestie:

  • -id Id — type (str,1), and the default is 0. it's the script id 🎀
  • -handle Self — type (self,1). it's the handle to self, she needs to hold her own hand 🫶
  • -disabled Disabled — type (bool,1), default is 0. it disables execution and piping, so like, the off switch 💀
  • -i Surface — type (vtkPolyData,1). this is your surface, your main character 🌈
  • -ifile SurfaceInputFileName — type (str,1). the filename for the default Surface reader 📖
  • -image Image — type (vtkImageData,1). the image in question 🌸
  • -imagefile ImageInputFileName — type (str,1). the filename for the default Image reader 📖
  • -iterations NumberOfIterations — type (int,1), >= 0, default is 100. how many laps she does 🔥
  • -stiffnesssubiterations NumberOfStiffnessSubIterations — type (int,1), >= 0, default is 0
  • -inflationsubiterations NumberOfInflationSubIterations — type (int,1), >= 0, default is 0
  • -potentialweight PotentialWeight — type (float,1), >= 0.0, default is 1.0
  • -stiffnessweight StiffnessWeight — type (float,1), >= 0.0, default is 1.0
  • -inflationweight InflationWeight — type (float,1), >= 0.0, default is 1.0
  • -convergence Convergence — type (float,1), >= 0.0, default is 1e-05
  • -maxtimestep MaxTimeStep — type (float,1), >= 0.0, default is 1.0
  • -timestep TimeStep — type (float,1), >= 0.0, default is 1.0
  • -adaptivetimestep AdaptiveTimeStep — type (bool,1), default is 1
  • -relaxation Relaxation — type (float,1), >= 0.0, default is 0.1
  • -dimensionality Dimensionality — type (int,1), >= 2 and <= 3, default is 3
  • -ofile SurfaceOutputFileName — type (str,1). the filename for the default Surface writer ✍️

💜 Output arguments 💜

and here's what she hands back to you when she's done, slay:

  • -id Id — type (str,1), default is 0. it's the script id 🎀
  • -handle Self — type (self,1). handle to self, again, she's still holding on 🫶
  • -o Surface — type (vtkPolyData,1). your shiny new surface, the after picture 🦋✨
ngl bestie, every default and every bound up there is load-bearing, so don't go freestyling values that aren't listed. the constraints are the constraints, fr fr. 🔥

that's the whole page!! written for vmtk version 1.5 and dated April 2026, so if you're reading this from some other timeline... girl, check your version 💀💅 bye bestie, go evolve a surface, you're gonna eat 🍓👑

📦 where this page comes from