VMTKBRANCHMETRICS(1)

💖 VMTKBRANCHMETRICS(1) 💖

okay bestie, welcome to the manual page for vmtkbranchmetrics, a user command from the vmtk script squad 🎀 no cap, this is a real one.

✨ NAME ✨

vmtkbranchmetrics — literally the vmtk script called vmtkbranchmetrics. that's the whole name, she's simple like that 💅

🌸 DESCRIPTION 🌸

so here's the vibe: the automatic piping kicks in first, then it parses the options for vmtkbranchmetrics. that's just how this script rolls, fr fr.

vmtkbranchmetrics takes a centerline plus an input surface that's already split into branches (and yes babe, the centerline attributes have to be calculated already too — that part is on you), and then it calculates the surface angular and abscissa metric. it's giving geometry homework but make it iconic 👑

🫶 Input arguments:

• -id Id (str,1); default=0 — the script id, the little name tag she wears
• -handle Self (self,1) — handle to self. yeah, she's holding her own hand, main character energy
• -disabled Disabled (bool,1); default=0 — disable execution and piping. flip her to off and she just. does not go. 💀
• -i Surface (vtkPolyData,1) — the input surface, drop her right in
• -ifile SurfaceInputFileName (str,1) — filename for the default Surface reader
• -centerlines Centerlines (vtkPolyData,1) — the input centerlines
• -centerlinesfile CenterlinesInputFileName (str,1) — filename for the default Centerlines reader
• -abscissametric ComputeAbscissaMetric (bool,1); default=1 — do the abscissa metric? default says yes
• -angularmetric ComputeAngularMetric (bool,1); default=1 — angular metric? also yes by default
• -abscissasarray AbscissasArrayName (str,1); default=Abscissas — where the abscissas live
• -normalsarray NormalsArrayName (str,1); default=ParallelTransportNormals — the normals array name
• -groupidsarray GroupIdsArrayName (str,1); default=GroupIds — group ids go here
• -centerlineidsarray CenterlineIdsArrayName (str,1); default=CenterlineIds — centerline ids go here
• -tractidsarray TractIdsArrayName (str,1); default=TractIds — tract ids go here
• -radiusarray RadiusArrayName (str,1); default=MaximumInscribedSphereRadius — the radius array name, obsessed with this default honestly
• -blankingarray BlankingArrayName (str,1); default=Blanking — blanking array name
• -angularmetricarray AngularMetricArrayName (str,1); default=AngularMetric — angular metric array name
• -abscissametricarray AbscissaMetricArrayName (str,1); default=AbscissaMetric — abscissa metric array name
• -ofile SurfaceOutputFileName (str,1) — filename for the default Surface writer

🦋 Output arguments:

• -id Id (str,1); default=0 — script id again, she contains multitudes
• -handle Self (self,1) — handle to self, encore
• -o Surface (vtkPolyData,1) — the output surface, she's grown 🥹
• -angularmetricarray AngularMetricArrayName (str,1); default=AngularMetric — angular metric array name
• -abscissametricarray AbscissaMetricArrayName (str,1); default=AbscissaMetric — abscissa metric array name

lowkey important: the input surface has to be already split into branches and the centerline attributes have to be already calculated before you run this. she is not doing that part for you, bestie 🙈

and that's the whole page!! this is version 1.5 of vmtkbranchmetrics, dated April 2026, and honestly? a serve. periodt. 💜✨🎀