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

CropSurfaceByNeighborsProximity

Header:	AVL.h
Namespace:	avl

Removes from the surface points that are too distant from their neighbor points.

Syntax

void avl::CropSurfaceByNeighborsProximity
(
	const avl::Surface& inSurface,
	atl::Optional<const avl::Region&> inRoi,
	const int inNeighborRadius,
	const float inMaxDistance,
	avl::Metric3D::Type inMetric,
	const float inMinNeighborRatio,
	bool inPreserveDimensions,
	avl::Surface& outSurface,
	atl::Optional<avl::Region&> outRejected = atl::NIL
)

Parameters

Name	Type	Range	Default	Description
inSurface	const Surface&
inRoi	Optional<const Region&>		NIL	Region of interest
inNeighborRadius	const int	1 -	1	Radius of neighbors to search for real neighbors
inMaxDistance	const float	0.0 -	2.0f	Maximal distance from another point to consider them real neighbors
inMetric	Metric3D::Type		Z	Metric used for measuring distance between points
inMinNeighborRatio	const float	0.0 - 1.0	1.0f	Fraction of valid neighbors in a given radius that have to be real neighbors
inPreserveDimensions	bool		False	Flag indicating whether the surface dimensions should be preserved or not
outSurface	Surface&
outRejected	Optional<Region&>		NIL	Region of locations where points are too distant from their neighbors

Optional Outputs

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

Errors

List of possible exceptions:

Error type	Description
DomainError	Incorrect metric in CropSurfaceByNeighborsProximity.