Operator Reference

pruningpruningPruningPruningpruning (Operator)

pruningpruningPruningPruningpruning — Prune the branches of a region.

Signature

pruning(Region : RegionPrune : Length : )

Herror pruning(const Hobject Region, Hobject* RegionPrune, const Hlong Length)

Herror T_pruning(const Hobject Region, Hobject* RegionPrune, const Htuple Length)

void Pruning(const HObject& Region, HObject* RegionPrune, const HTuple& Length)

HRegion HRegion::Pruning(Hlong Length) const

static void HOperatorSet.Pruning(HObject region, out HObject regionPrune, HTuple length)

HRegion HRegion.Pruning(int length)

def pruning(region: HObject, length: int) -> HObject

Description

pruningpruningPruningPruningpruning removes branches from a skeleton (RegionRegionRegionregionregion) having a length less than LengthLengthLengthlengthlength. All other branches are preserved.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Automatically parallelized on tuple level.

Parameters

RegionRegionRegionregionregion (input_object)  region(-array) objectHRegionHObjectHObjectHobject

Regions to be processed.

RegionPruneRegionPruneRegionPruneregionPruneregion_prune (output_object)  region(-array) objectHRegionHObjectHObjectHobject *

Result of the pruning operation.

LengthLengthLengthlengthlength (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Length of the branches to be removed.

Default: 2

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 17, 20, 30, 40, 50

Value range: 1 ≤ Length Length Length length length ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 1

Complexity

Let F be the area of the input region. Then the runtime complexity for one region is

Result

pruningpruningPruningPruningpruning returns 2 ( H_MSG_TRUE) if all parameters are correct. The behavior in case of empty or no input region can be set via:

Otherwise, an exception is raised.

Possible Predecessors

skeletonskeletonSkeletonSkeletonskeleton

Possible Successors

reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain, select_shapeselect_shapeSelectShapeSelectShapeselect_shape, area_centerarea_centerAreaCenterAreaCenterarea_center, connectionconnectionConnectionConnectionconnection

See also

junctions_skeletonjunctions_skeletonJunctionsSkeletonJunctionsSkeletonjunctions_skeleton

Module

Foundation