Start » Filter Reference » Surface » Surface Spatial Transforms » CropSurface
Module: | Vision3DStandard |
---|
Removes from the surface points that are not contained in a given rectangular box.
Name | Type | Description | |
---|---|---|---|
inSurface | Surface | Input surface | |
inRoi | Region* | Region of interest | |
inXLimits | ValueLimits_f64 | ||
inYLimits | ValueLimits_f64 | ||
inZLimits | ValueLimits_f64 | ||
inPreserveDimensions | Bool | Flag indicating whether the surface dimensions should be preserved or not | |
outSurface | Surface | Output surface | |
outRejected | Region | Region of locations where points are not contained in a given rectangular box |
Description
The operation removes points from surface that are not contained in a given rectangular box within provided coordinates.
It is also possible to narrow this box by editing inRoi, Region of Interest of operation.
Coordinates are defined via acceptable limits for their values. E.g. inXLimits.MinValue is minimum and inXLimits.MaxValue is maximum value of the X coordinate. Every point with its X coordinate outside of this range is removed.
Flag inPreserveDimensions informs if the operation output should keep the original dimensions of its input. E.g. if inSurface has its Width=300, Height=200 and Pitch=608 and the flag is enabled, the outSurface will have exactly the same dimensions of 300x200x608. However, if the flag is disabled, outSurface will have its dimensions smaller to adjust them to surface size, but its XOffset, YOffset, ZOffset properties will be accordingly bigger in order to keep the surface in the same place in workspace.
Operation returns the cropped Surface as well as removed Region if one needs to perform further actions on removed points.
Examples
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Region of interest exceeds an input surface in CropSurface. |
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filter is member of CropSurface filter group.
See Also
- CropSurfaceToRegion – Removes points that are not present in a given region.
- TestSurface – Returns a sample 3D surface.