Back to FabImage Library website

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

SplitSurfaceByPlane


Header:FIL.h
Namespace:fil

Separates the surface points being on one side of the input plane from the others.

Syntax

C++
C#
 
void fil::SplitSurfaceByPlane
(
	const fil::Surface& inSurface,
	ftl::Optional<const fil::Region&> inRoi,
	const fil::Plane3D& inPlane,
	bool inPreserveDimensions,
	fil::Surface& outSurface1,
	fil::Surface& outSurface2
)

Parameters

Name Type Default Description
inSurface const Surface& Input surface
inRoi Optional<const Region&> NIL Region of interest
inPlane const Plane3D& Plane used for splitting
inPreserveDimensions bool False Flag indicating whether the surface dimensions should be preserved or not
outSurface1 Surface& Surface with points with positive signed distance to the input plane
outSurface2 Surface& Surface with points with negative signed distance to the input plane

Errors

List of possible exceptions:

Error type Description
DomainError Indefinite plane on input in SplitSurfaceByPlane.