Back to FabImage Library website

You are here: Start » Function Reference » Surface » Surface Spatial Transforms » CropSurfaceByPlaneProximity

CropSurfaceByPlaneProximity


Header: FIL.h
Namespace: fil
Module: Vision3DStandard

Removes from the surface points that are too distant from a given plane.

Syntax

C++
C#
 
void fil::CropSurfaceByPlaneProximity
(
	const fil::Surface& inSurface,
	ftl::Optional<const fil::Region&> inRoi,
	const fil::Plane3D& inPlane,
	ftl::Optional<float> inMinDistance,
	ftl::Optional<float> inMaxDistance,
	bool inPreserveDimensions,
	fil::Surface& outSurface,
	ftl::Optional<fil::Region&> outRejected = ftl::NIL
)

Parameters

Name Type Default Description
Input value
 inSurface const Surface& Input surface
Input value
 inRoi Optional<const Region&> NIL Region of interest
Input value
 inPlane const Plane3D& Plane to which distance is measured
Input value
 inMinDistance Optional<float> NIL Minimal distance from a given plane
Input value
 inMaxDistance Optional<float> 1.0f Maximal distance from a given plane
Input value
 inPreserveDimensions bool False Flag indicating whether the surface dimensions should be preserved or not
Output value
 outSurface Surface& Output surface
Output value
 outRejected Optional<Region&> NIL Region of locations where points are too distant from the input plane

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outRejected.

Read more about Optional Outputs.

Errors

List of possible exceptions:

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