SurfaceToPlaneDistanceImage


Computes the image of the distances of the input surface points from a given plane.

Syntax

C++
C#
Python
 
def SurfaceToPlaneDistanceImage(
	inSurface: Surface,
	inPlane: Plane3D,
	inResolution: float,
	outDistanceImage: Image,
	/,
	*,
	inRoi: Region | None = None,
	inSignedDistance: bool = False
)
-> None

Parameters

Name Type Range Default Description
Input value inSurface Surface Input surface
Input value inRoi Region | None None Range of pixels to be processed
Input value inPlane Plane3D Input plane
Input value inResolution float 0.0 - Number of real-world units per one pixel
Input value inSignedDistance bool False Flag indicating whether to compute signed distance to the plane
Output value outDistanceImage Image

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.