Back to Aurora Vision Library website
You are here: Start » Function Reference » Surface » Surface Spatial Transforms » CropSurfaceByPlaneProximity
CropSurfaceByPlaneProximity
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | Vision3DStandard |
Removes from the surface points that are too distant from a given plane.
Syntax
C++
C#
void avl::CropSurfaceByPlaneProximity ( const avl::Surface& inSurface, atl::Optional<const avl::Region&> inRoi, const avl::Plane3D& inPlane, atl::Optional<float> inMinDistance, atl::Optional<float> inMaxDistance, 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 | |
inPlane | const Plane3D& | Plane to which distance is measured | ||
inMinDistance | Optional<float> | NIL | Minimal distance from a given plane | |
inMaxDistance | Optional<float> | 1.0f | Maximal distance from a given plane | |
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 too distant from the input plane |
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 | Indefinite plane on input in CropSurfaceByPlaneProximity. |
DomainError | Region of interest exceeds an input surface in CropSurfaceByPlaneProximity. |