Back to Aurora Vision Library website

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

CropSurface_Relative


Header: AVL.h
Namespace: avl
Module: Vision3DStandard

Removes from the surface points that are relatively too distant from their average neighbor points in a local rectangular neighborhood.

Syntax

C++
C#
 
void avl::CropSurface_Relative
(
	const avl::Surface& inSurface,
	atl::Optional<const avl::Region&> inRoi,
	const avl::Surface& inBaseSurface,
	atl::Optional<float> inMinRelativeHeight,
	atl::Optional<float> inMaxRelativeHeight,
	float inHysteresis,
	bool inPreserveDimensions,
	avl::Surface& outSurface,
	atl::Optional<avl::Region&> outRejected = atl::NIL
)

Parameters

Name Type Range Default Description
Input value inSurface const Surface& Input surface
Input value inRoi Optional<const Region&> NIL Region of interest
Input value inBaseSurface const Surface& Heights of this surface are subtracted from inSurface heights before crop
Input value inMinRelativeHeight Optional<float> NIL Minimum relative height of a point to be not removed
Input value inMaxRelativeHeight Optional<float> NIL Maximum relative height of a point to be not removed
Input value inHysteresis float 0.0 - 0.0f Defines how much the threshold criteria are lowered for points neighboring with other not removed points
Input value inPreserveDimensions bool False Flag indicating whether the surface dimensions should be preserved or not
Output value outSurface Surface&
Output value outRejected Optional<Region&> NIL Region of locations where points are removed

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.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Region of interest exceeds an input surface in CropSurface_Relative.
DomainError Surface formats are not the same in CropSurface_Relative.
DomainError Surface sizes are not equal in CropSurface_Relative.