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

CropSurfaceToBox3D

Header:	FIL.h
Namespace:	fil

Removes from the surface points that are not contained in a given box in 3D.

Syntax

void fil::CropSurfaceToBox3D
(
	const fil::Surface& inSurface,
	ftl::Optional<const fil::Region&> inRoi,
	const fil::Box3D& inBox3D,
	bool inPreserveDimensions,
	fil::Surface& outSurface,
	ftl::Optional<fil::Region&> outRejected = ftl::NIL
)

Parameters

Name	Type	Default	Description
inSurface	const Surface&		Input surface
inRoi	Optional<const Region&>	NIL	Region of interest
inBox3D	const Box3D&		Box defining a subspace to be cropped
inPreserveDimensions	bool	False	Flag indicating whether the surface dimensions should be preserved or not
outSurface	Surface&		Output surface
outRejected	Optional<Region&>	NIL	Region of locations where points are not contained in a given box in 3D

Optional Outputs

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