You are here: Start » FIL.NET » Function Reference » Surface » Surface Features » FIL.SurfaceToPlaneDistanceImage
Computes the image of the distances of the input surface points from a given plane.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void SurfaceToPlaneDistanceImage ( FilNet.Surface inSurface, NullableRef<FilNet.Region> inRoi, FilNet.Plane3D inPlane, float inResolution, bool inSignedDistance, FilNet.Image outDistanceImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inSurface | FilNet.Surface | Input surface. | ||
![]() | inRoi | FilNet.NullableRef<FilNet.Region> | Range of pixels to be processed. Default value: ftl::NIL. | ||
![]() | inPlane | FilNet.Plane3D | Input plane. | ||
![]() | inResolution | float | <0.0f, INF> | 1.0f | Number of real-world units per one pixel. Default value: 1.0f. |
![]() | inSignedDistance | bool | False | Flag indicating whether to compute signed distance to the plane. Default value: False. | |
![]() | outDistanceImage | FilNet.Image |
Hardware Acceleration
This operation supports automatic parallelization for multicore and multiprocessor systems.
Hardware acceleration settings may be manipulated with Settings class.
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. |