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

AVL.CropSurface_Relative

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void CropSurface_Relative
(
	AvlNet.Surface inSurface,
	NullableRef<AvlNet.Region> inRoi,
	AvlNet.Surface inBaseSurface,
	float? inMinRelativeHeight,
	float? inMaxRelativeHeight,
	float inHysteresis,
	bool inPreserveDimensions,
	AvlNet.Surface outSurface,
	NullableRef<AvlNet.Region> outRejected
)

Parameters

Name Type Range Default Description
inSurfaceAvlNet.SurfaceInput surface.
inRoiAvlNet.NullableRef<AvlNet.Region>Region of interest. Default value: atl::NIL.
inBaseSurfaceAvlNet.SurfaceHeights of this surface are subtracted from inSurface heights before crop.
inMinRelativeHeightfloat?Minimum relative height of a point to be not removed. Default value: atl::NIL.
inMaxRelativeHeightfloat?Maximum relative height of a point to be not removed. Default value: atl::NIL.
inHysteresisfloat<0.0f, INF>0.0fDefines how much the threshold criteria are lowered for points neighboring with other not removed points. Default value: 0.0f.
inPreserveDimensionsboolFalseFlag indicating whether the surface dimensions should be preserved or not. Default value: False.
outSurfaceAvlNet.Surface
outRejectedAvlNet.NullableRef<AvlNet.Region>Region of locations where points are removed. Can be null to skip this parameter calculation.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Hardware acceleration settings may be manipulated with Settings class.

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.

Function Overrides

See also