Back to FabImage Studio website

You are here: Start » Filter Reference » Surface » Surface Features » SurfaceToPlaneDistanceImage

SurfaceToPlaneDistanceImage


Module: Vision3DStandard

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

Name Type Range Description
Input value
inSurface Surface Input surface
Input value
inRoi Region* Range of pixels to be processed
Input value
inPlane Plane3D Input plane
Input value
inResolution Real 0.0 - Number of real-world units per one pixel
Input value
inSignedDistance Bool 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.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Indefinite plane on input in SurfaceToPlaneDistanceImage.
DomainError Region of interest exceeds an input surface in SurfaceToPlaneDistanceImage.

Complexity Level

This filter is available on Basic Complexity Level.