Back to Aurora Vision Library website
You are here: Start » Function Reference » Surface » Surface Spatial Transforms » CropSurfaceToBox3D
CropSurfaceToBox3D
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | Vision3DStandard |
Removes from the surface points that are not contained in a given box in 3D.
Syntax
C++
C#
void avl::CropSurfaceToBox3D ( const avl::Surface& inSurface, atl::Optional<const avl::Region&> inRoi, const avl::Box3D& inBox3D, bool inPreserveDimensions, avl::Surface& outSurface, atl::Optional<avl::Region&> outRejected = atl::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 atl::NIL
to these parameters: outRejected.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Region of interest exceeds an input surface in CropSurfaceToBox3D. |