Skip to content

Unwrap

ImageUnwrap - Unwrap_UsingCircles

Unwraps the area contained between two circles.

IN

Name Type Description
InImage Image Input image.
InTemplate1 Circle2D First circle which marks the unwrapping area.
InTemplate2 Circle2D Second circle which marks the unwrapping area.
InPhase Float Offset applied to the angles used during the unwrapping procedure.
InInvertCircle Bool If true, the input image is sampled starting from the second template, towards the first one.
InInvertRotation Bool If true, the image is sampled in the counter-clockwise direction.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Unwrapped image.
Error ErrorState Gets the execution error message

ImageUnwrap - Unwrap_UsingEllipses

Unwraps the area contained between two ellipses.

IN

Name Type Description
InImage Image Input image.
InTemplate1 Ellipse2D First ellipse which marks the unwrapping area.
InTemplate2 Ellipse2D Second ellipse which marks the unwrapping area.
InPhase Float Offset applied to the angles used during the unwrapping procedure.
InInvertCircle Bool If true, the input image is sampled starting from the second template, towards the first one.
InInvertRotation Bool If true, the image is sampled in the counter-clockwise direction.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Unwrapped image.
Error ErrorState Gets the execution error message

ImageUnwrap - Unwrap_UsingPath

Unwraps the area contained nearby an axis path.

IN

Name Type Description
InImage Image Input image.
InUnwrappingPath Path Path used to unwrap the image. The path cannot be empty.
InScanWidth Int Width of the area built around the unwrapping path. Range 〔1, +inf〕.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Unwrapped image.
Error ErrorState Gets the execution error message