You are here: Start » FIL.NET » Function Reference » Data Classification » Statistics » FIL.FindDensityMaxima_FixedSpread

FIL.FindDensityMaxima_FixedSpread

Finds local density maxima in a set of values by looking for the highest number of samples withing a range determined by the given spread.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void FindDensityMaxima_FixedSpread
(
	IList<float> inValues,
	float inSpread,
	int inMinCount,
	bool inAllowOverlapping,
	FilNet.DataModeFunction inModeFunction,
	IList<float> outModes,
	IList<int> outCounts
)

Parameters

Name Type Range Default Description
inValuesSystem.Collections.Generic.IList<float>Data points array.
inSpreadfloat<0.0f, INF>2.0fMaximum spread of a single window. Default value: 2.0f.
inMinCountint<1, INF>1Windows with a smaller count will not be considered. Default value: 1.
inAllowOverlappingboolIf true all local maxima will be returned otherwise for each group of ranges that overlap only the one with the smallest real spread will be returned.
inModeFunctionFilNet.DataModeFunctionMeanMethod of calculating the center of a data mode. Default value: Mean.
outModesSystem.Collections.Generic.IList<float>Computed data modes.
outCountsSystem.Collections.Generic.IList<int>Sizes 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 bounded spread.

Overlapping windows (i.e. a series of windows with the same count) can be sieved if inAllowOverlapping is set to false. The sieving removes all modes that are shadowed by (i.e. are overlapping with) another mode with a smaller spread.

inMinCount 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_FixedSpread.

Function Overrides

See also