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

SurfaceToPlaneDistanceImage

Header:	FIL.h
Namespace:	fil

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

Syntax

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&

Errors

List of possible exceptions:

Error type	Description
DomainError	Indefinite plane on input in SurfaceToPlaneDistanceImage.