Back to FabImage Library website
You are here: Start » Function Reference » Surface » Surface Features » SurfaceToPlaneDistanceImage
SurfaceToPlaneDistanceImage
Header: | FIL.h |
---|---|
Namespace: | fil |
Module: | Vision3DStandard |
Computes the image of the distances of the input surface points from a given plane.
Syntax
C++
C#
void fil::SurfaceToPlaneDistanceImage ( const fil::Surface& inSurface, ftl::Optional<const fil::Region&> inRoi, const fil::Plane3D& inPlane, float inResolution, bool inSignedDistance, fil::Image& outDistanceImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSurface | const Surface& | Input surface | |||
inRoi | Optional<const Region&> | NIL | Range of pixels to be processed | ||
inPlane | const Plane3D& | Input plane | |||
inResolution | float | 0.0 - | 1.0f | Number of real-world units per one pixel | |
inSignedDistance | bool | False | Flag indicating whether to compute signed distance to the plane | ||
outDistanceImage | Image& |
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Indefinite plane on input in SurfaceToPlaneDistanceImage. |
DomainError | Region of interest exceeds an input surface in SurfaceToPlaneDistanceImage. |