Skip to content

Features

Path - ExtractPoints

Extracts all the points from a group of paths.

IN

Name Type Description
InPaths PathArray Input paths.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2DArray An array with all the points.
Error ErrorState Gets the execution error message

Path - GetAverageTurnAngle

Computes the average turning angle (per unit of length) between consecutive segments of the path.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float The computed value.
Error ErrorState Gets the execution error message

Path - GetBoundingBox

Computes the smallest rectangle box that contains the entire path.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutBox Box The computed box.
Error ErrorState Gets the execution error message

Path - GetBoundingCircle

Computes the smallest circle that contains the entire path.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCircle2D Circle2D The computed circle.
Error ErrorState Gets the execution error message

Path - GetBoundingRect

Computes the smallest rectangle that contains the entire path.

IN

Name Type Description
InPath Path The input Path
InRectangleOrientation Enum < RectangleOrientation > Selects how the rectangle orientation will be normalized.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRectangle2D Rectangle2D The computed rectangle.
Error ErrorState Gets the execution error message

Path - GetCaliperDiameters

Computes the longest and the shortest segments between two points of the path.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPath Path The modified Core.Data.Types.Path
Error ErrorState Gets the execution error message

Path - GetConvexHull

Computes the path's convex hull.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPath Path The computed convex hull.
Error ErrorState Gets the execution error message

Path - GetDiameter

Finds the longest segment connecting two points of the path.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSegment2D Segment2D The computed segment.
Error ErrorState Gets the execution error message

Path - GetFirstPoint

Returns the first path point.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The first path point.
Error ErrorState Gets the execution error message

Path - GetLastPoint

Returns the last path point.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The last path point.
Error ErrorState Gets the execution error message

Path - GetLength

Computes the length of the path.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float The computed length.
Error ErrorState Gets the execution error message

Path - GetMassCenter

Computes the path's mass center.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutPoint2D Point2D The computed point.
Error ErrorState Gets the execution error message

Path - GetMaxTurnAngle

Computes the maximum turn angle between the path's consecutive segments.

IN

Name Type Description
InPath Path The input Path
InTurnAngleDirection Enum < TurnAngleDirection > Filters which type of turn must be considered (left, right, all).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float The value of the maximum turn angle.
Error ErrorState Gets the execution error message

Path - GetSegments

Converts the path to an array of Segment2D objects.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSegment2D Segment2DArray The computed array.
Error ErrorState Gets the execution error message

Path - GetTurnAngleLocalMaxima

Computes the local maxima of the path's turn angle profile.

IN

Name Type Description
InPath Path The input Path
InTurnAngleDirection Enum < TurnAngleDirection > Filters which type of turn must be considered (left, right, all).
InMinTurnAngle Float Minimum allowed angle. Range: 〔0, 180〕.
InMinDistance Float Minimum allowed distance between two local maxima. It assumes that each segment has a unit length. Range: 〔0, +inf).
InSmoothingStdDev Float Standard deviation of the Gaussian kernel used to smooth the path. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat FloatArray Array containing the values of the local maxima.
Error ErrorState Gets the execution error message

Path - GetTurnAngleProfile

Computes the turning angles for each point of the path.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutProfile Profile The computer profile.
Error ErrorState Gets the execution error message

Path - IntersectsWith

Check if the Path (closed) is intersecting with the given Path (closed).

IN

Name Type Description
InPath1 Path The input Path
InPath2 Path input Path. Needs to be closed.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutBool Bool true if the Path intersect with the input Path.
Error ErrorState Gets the execution error message

Path - SelfIntersects

Tests if the path has self-intersections.

IN

Name Type Description
InPath Path The input Path
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutBool Bool true if any self-intersection is found, false otherwise.
Error ErrorState Gets the execution error message