You are here: Start » AVL.NET » Function Reference » Data Classification » Statistics » AVL.FindDensityMaxima_FixedCount

AVL.FindDensityMaxima_FixedCount

Finds local density maxima in set of values by looking for the highest concentration of a fixed number of samples.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void FindDensityMaxima_FixedCount
(
	IList<float> inValues,
	int inCount,
	float? inMaxSpread,
	bool inAllowOverlapping,
	float? inCycle,
	AvlNet.DataModeFunction inModeFunction,
	AvlNet.LocalBlindness? inLocalBlindness,
	IList<float> outModes,
	IList<float> outSpreads
)

Parameters

Name Type Range Default Description
inValuesSystem.Collections.Generic.IList<float>Data points array.
inCountint<2, INF>3Number of points in a single window. Default value: 3.
inMaxSpreadfloat?Maximum spread of points within a window. Default value: atl::NIL.
inAllowOverlappingboolIf true all local maxima will be returned otherwise for each group of ranges that overlap a single mode will be returned (the middle of the group).
inCyclefloat?Length of the cycle if data is to be considered cyclically. Default value: atl::NIL.
inModeFunctionAvlNet.DataModeFunctionMeanMethod of calculating the center of a data mode. Default value: Mean.
inLocalBlindnessAvlNet.LocalBlindness?Helps to sieve out unnecessary points. Default value: atl::NIL.
outModesSystem.Collections.Generic.IList<float>Computed data modes.
outSpreadsSystem.Collections.Generic.IList<float>Spreads of windows that had a mode.

Description

Find approximations of local density maxima in a data sample by looking for highest concentrations in a window with a fixed number of samples.

Overlapping windows (i.e. a series of windows with the same count and the same spread) can be returned as a single mode (the middle those windows) if inAllowOverlapping is set to false.

inMaxSpread and inLocalBlindness can be used to further filter out potentially unnecessary points in the output.

Errors

List of possible exceptions:

Error type Description
DomainError Empty array in FindDensityMaxima_FixedCount.
DomainError Unsupported mode function in FindDensityMaxima_FixedCount.

Function Overrides

See also