Click or drag to resize
NChartPeakDetector Class
The NChartPeakDetector class provides methods to detect peak values inside the given point array. The detection is based on the deviation from moving average.
Inheritance Hierarchy
SystemObject
  NChart3D_UWPNChartPeakDetector

Namespace:  NChart3D_UWP
Assembly:  NChart3D_UWP (in NChart3D_UWP.dll)
Syntax
public sealed class NChartPeakDetector : INChartPointAnalyzer

The NChartPeakDetector type exposes the following members.

Constructors
  NameDescription
Public methodNChartPeakDetector
Initializes a new instance of the NChartPeakDetector class
Top
Properties
  NameDescription
Public propertyAbsoluteThreshold
Flag determining if Threshold is absolute (true) or relative (false). The default value is false. Absolute threshold means that it is given in the same units as the values in the analyzed points. Relative threshold represents a fraction of |max - min|, where max is the maximal value in the given points array and min is the minimal one. So if, for example, min = 0, max = 10, threshold is set to 0.3 and this flag is true, then the actual threshold the peaks will be search according to will be 0.3. But if this flag is false, the actual threshold will be 0.3 * (10 - 0) = 3. Normally it's reasonable to use relative threshold if you don't know the bounds of your values. However, this will mean an additional scan through the points to determine min and max values, so the processing will take a bit more time.
Public propertyFindMax
Flag determining if peak detector should find up-peaks (true), or not (false). The default value is true. The up-peaks are defined as peaks laying below the moving average inside the search window.
Public propertyFindMin
Flag determining if peak detector should find down-peaks (true), or not (false). The default value is true. The down-peaks are defined as peaks laying beneath the moving average inside the search window.
Public propertyStepDimension
Key of the value that should be interpreted as step dimension. Typically it is NChartValue.X (which is the default value), however for bar series it should be NChartValue.Y.
Public propertyThreshold
Threshold to search the peaks according to. The default value is 0.3. See AbsoluteThreshold for details about how this value is interpreted.
Public propertyValueDimension
Key of the value that should be interpreted as height dimension. Typically it is NChartValue.Y (which is the default value), however for bar series it should be NChartValueX.
Public propertyWindowWidth
Width (in number of points) of the search window needed to calculate moving average. The default value is 5.
Top
Methods
See Also