You are here: Start » Filter Reference » Data Classification » Statistics » FindDensityMaxima_FixedSpread

FindDensityMaxima_FixedSpread

Module:	FoundationPro

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.

Applications

Can be used to determine histogram's local maxima without actually creating the histogram.

Name	Type	Range	Description
inValues	Real Array		Data points array
inSpread	Real	0.0 -	Maximum spread of a single window
inMinCount	Integer	1 -	Windows with a smaller count will not be considered
inAllowOverlapping	Bool		If 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
inCycle	Real *		Length of the cycle if data is to be considered cyclically
inModeFunction	DataModeFunction		Method of calculating the center of a data mode
inLocalBlindness	LocalBlindness *		Helps to sieve out unnecessary points
outModes	Real Array		Computed data modes
outCounts	Integer Array		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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type	Description
DomainError	Empty array in FindDensityMaxima_FixedSpread.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group