vmtkbranchsections

Description

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.

Input arguments

ArgumentVariableTypeLengthRangeDefaultDescription
idIdstr10script id
handleSelfself1handle to self
disabledDisabledbool10disable execution and piping
iSurfacevtkPolyData1the input surface, already split into branches
ifileSurfaceInputFileNamestr1filename for the default Surface reader
centerlinesCenterlinesvtkPolyData1the input centerlines, already split into branches
centerlinesfileCenterlinesInputFileNamestr1filename for the default Centerlines reader
distancespheresNumberOfDistanceSpheresint1(0,)1distance from the bifurcation at which the sections have to be taken; the distance is expressed in number of inscribed spheres, where each sphere touches the center of the previous one
reverseReverseDirectionbool10toggle start generating sections from the end of the branches rather than the start
radiusarrayRadiusArrayNamestr1MaximumInscribedSphereRadiusname of the array where centerline radius is stored
groupidsarrayGroupIdsArrayNamestr1GroupIdsname of the array where centerline group ids are stored
centerlineidsarrayCenterlineIdsArrayNamestr1CenterlineIdsname of the array where centerline ids are stored
tractidsarrayTractIdsArrayNamestr1TractIdsname of the array where centerline tract ids are stored
blankingarrayBlankingArrayNamestr1Blankingname of the array where centerline blanking information about branches is stored
branchsectiongroupidsBranchSectionGroupIdsArrayNamestr1BranchSectionGroupIdsname of the array where the group id to which each section belongs has to be stored
branchsectionareaBranchSectionAreaArrayNamestr1BranchSectionAreaname of the array where the area of bifurcation sections have to be stored
branchsectionminsizeBranchSectionMinSizeArrayNamestr1BranchSectionMinSizename of the array where the minimum diameter of each section has to be stored
branchsectionmaxsizeBranchSectionMaxSizeArrayNamestr1BranchSectionMaxSizename of the array where the maximum diameter of each bifurcation sections has to be stored
branchsectionshapeBranchSectionShapeArrayNamestr1BranchSectionShapename of the array where the shape index, i.e. the ratio between minimum and maximum diameter, of each bifurcation section has to be stored
branchsectionclosedBranchSectionClosedArrayNamestr1BranchSectionClosedname of the array containing 1 if a section is closed and 0 otherwise
branchsectiondistancespheresBranchSectionDistanceSpheresArrayNamestr1BranchSectionDistanceSpheresname of the array containing the number of distance spheres the section is taken at
ofileBranchSectionsOutputFileNamestr1filename for the default BranchSections writer

Output arguments

ArgumentVariableTypeLengthRangeDefaultDescription
idIdstr10script id
handleSelfself1handle to self
oBranchSectionsvtkPolyData1the output sections
branchsectiongroupidsBranchSectionGroupIdsArrayNamestr1BranchSectionGroupIdsname of the array where the group id to which each section belongs are stored
branchsectionareaBranchSectionAreaArrayNamestr1BranchSectionAreaname of the array where the area of bifurcation sections are stored
branchsectionminsizeBranchSectionMinSizeArrayNamestr1BranchSectionMinSizename of the array where the minimum diameter of each section are stored
branchsectionmaxsizeBranchSectionMaxSizeArrayNamestr1BranchSectionMaxSizename of the array where the minimum diameter of each bifurcation sections has to be stored
branchsectionshapeBranchSectionShapeArrayNamestr1BranchSectionShapename of the array where the shape index, i.e. the ratio between minimum and maximum diameter, of each bifurcation section are stored
branchsectionclosedBranchSectionClosedArrayNamestr1BranchSectionClosedname of the array containing 1 if a section is closed and 0 otherwise
branchsectiondistancespheresBranchSectionDistanceSpheresArrayNamestr1BranchSectionDistanceSpheresname of the array containing the number of distance spheres the section is taken at