VMTKBRANCHSECTIONS(1)

πŸ“¦ version 1.5.0, in ubuntu stonking

πŸ’– NAME πŸ’–

vmtkbranchsections β€” the vmtk script literally named vmtkbranchsections. One (1) manual page, filed under User Commands, and yes bestie we are reading it together, grabbing a lil snack first πŸ“


✨ DESCRIPTION ✨

Okay so here's the auto-generated opener, exactly as the script spits it out, no notes: "Automatic piping vmtkbranchsections Parsing options vmtkbranchsections" β€” that's the piping-and-parsing boilerplate, it's giving robot voice, we respect it πŸ’€

Now the real tea: vmtkbranchsections : compute geometric properties of branch sections located a fixed number of spheres away from each bifurcation. The script takes in input the surface and the relative centerlines, both already split into branches β€” like, that part is not optional, they come pre-split, okay? πŸ¦‹


πŸŽ€ Input arguments πŸŽ€

  • -id β€” Id (str,1); default=0: the script id. every script has one, it's their lil name tag πŸͺͺ
  • -handle β€” Self (self,1): handle to self. it's the handle to self, iykyk
  • -disabled β€” Disabled (bool,1); default=0: set this and execution and piping are just… off. nothing runs. silence πŸ’€
  • -i β€” Surface (vtkPolyData,1): your input surface β€” and it must already be split into branches, we said what we said
  • -ifile β€” SurfaceInputFileName (str,1): the filename for the default Surface reader
  • -centerlines β€” Centerlines (vtkPolyData,1): the input centerlines β€” also already split into branches ✨
  • -centerlinesfile β€” CenterlinesInputFileName (str,1): the filename for the default Centerlines reader
  • -distancespheres β€” NumberOfDistanceSpheres (int,1) >= 0; default=1: how far away from the bifurcation the sections get taken, measured in number of inscribed spheres, where each sphere touches the center of the previous one 🫧 obsessed with the geometry of it tbh
  • -reverse β€” ReverseDirection (bool,1); default=0: toggle it and sections start generating from the end of the branches instead of the start. lil direction flip πŸ”
  • -radiusarray β€” RadiusArrayName (str,1); default=MaximumInscribedSphereRadius: the array where the centerline radius is stored
  • -groupidsarray β€” GroupIdsArrayName (str,1); default=GroupIds: the array where centerline group ids are stored
  • -centerlineidsarray β€” CenterlineIdsArrayName (str,1); default=CenterlineIds: the array where centerline ids are stored
  • -tractidsarray β€” TractIdsArrayName (str,1); default=TractIds: the array where centerline tract ids are stored
  • -blankingarray β€” BlankingArrayName (str,1); default=Blanking: the array where the centerline blanking information about branches is stored
  • -branchsectiongroupids β€” BranchSectionGroupIdsArrayName (str,1); default=BranchSectionGroupIds: the array where the group id that each section belongs to has to be stored
  • -branchsectionarea β€” BranchSectionAreaArrayName (str,1); default=BranchSectionArea: the array where the area of bifurcation sections has to be stored
  • -branchsectionminsize β€” BranchSectionMinSizeArrayName (str,1); default=BranchSectionMinSize: the array where the minimum diameter of each section has to be stored
  • -branchsectionmaxsize β€” BranchSectionMaxSizeArrayName (str,1); default=BranchSectionMaxSize: the array where the maximum diameter of each bifurcation section has to be stored
  • -branchsectionshape β€” BranchSectionShapeArrayName (str,1); default=BranchSectionShape: the array where the shape index has to be stored β€” and the shape index is, and I quote, the ratio between minimum and maximum diameter, of each bifurcation section πŸ“
  • -branchsectionclosed β€” BranchSectionClosedArrayName (str,1); default=BranchSectionClosed: the array containing 1 if a section is closed and 0 otherwise. binary icon behavior
  • -branchsectiondistancespheres β€” BranchSectionDistanceSpheresArrayName (str,1); default=BranchSectionDistanceSpheres: the array containing the number of distance spheres the section is taken at
  • -ofile β€” BranchSectionsOutputFileName (str,1): the filename for the default BranchSections writer

🌈 Output arguments 🌈

  • -id β€” Id (str,1); default=0: script id. yes again. it comes in and it goes out πŸͺͺ
  • -handle β€” Self (self,1): handle to self. also again. consistency queen πŸ‘‘
  • -o β€” BranchSections (vtkPolyData,1): the output sections, bestie, the whole point, the main character πŸŽ€
  • -branchsectiongroupids β€” BranchSectionGroupIdsArrayName (str,1); default=BranchSectionGroupIds: the array where the group id to which each section belongs are stored
  • -branchsectionarea β€” BranchSectionAreaArrayName (str,1); default=BranchSectionArea: the array where the area of bifurcation sections are stored
  • -branchsectionminsize β€” BranchSectionMinSizeArrayName (str,1); default=BranchSectionMinSize: the array where the minimum diameter of each section are stored
  • -branchsectionmaxsize β€” BranchSectionMaxSizeArrayName (str,1); default=BranchSectionMaxSize: the array where the minimum diameter of each bifurcation section has to be stored (yes, the docs say minimum here in the output list, we are simply reporting what it says, don't shoot the messenger πŸ™ˆ)
  • -branchsectionshape β€” BranchSectionShapeArrayName (str,1); default=BranchSectionShape: the array where the shape index β€” that's the ratio between minimum and maximum diameter β€” of each bifurcation section are stored
  • -branchsectionclosed β€” BranchSectionClosedArrayName (str,1); default=BranchSectionClosed: the array containing 1 if a section is closed and 0 otherwise
  • -branchsectiondistancespheres β€” BranchSectionDistanceSpheresArrayName (str,1); default=BranchSectionDistanceSpheres: the array containing the number of distance spheres the section is taken at

πŸ’‘ tiny heads-up bestie: a bunch of these names appear once in Input arguments and again in Output arguments. Same flags, same defaults β€” that's just how the page lists them. Don't @ me, @ the manpage.

and that's the whole page, we ate, no crumbs left 🌸

sign-off: this was vmtkbranchsections version 1.5, fresh out of April 2026 πŸ’… slay, go split some branches (remember: already split 😭), periodt 🫢

πŸ“¦ where this page comes from