The NChartPeakDetector class provides methods to detect peak values inside the given point array. More...
Public Member Functions | |
| boolean | isFindMin () |
| Flag determining if peak detector should find down-peaks (true), or not (false). More... | |
| void | setFindMin (boolean findMin) |
| For details see isFindMin(). | |
| boolean | isFindMax () |
| Flag determining if peak detector should find up-peaks (true), or not (false). More... | |
| void | setFindMax (boolean findMax) |
| For details see isFindMax(). | |
| boolean | isAbsoluteThreshold () |
| Flag determining if getThreshold() is absolute (true) or relative (false). More... | |
| void | setAbsoluteThreshold (boolean absoluteThreshold) |
| For details see isAbsoluteThreshold(). | |
| double | getThreshold () |
| Threshold to search the peaks according to. More... | |
| void | setThreshold (double threshold) |
| For details see getThreshold(). | |
| int | getWindowWidth () |
| Width (in number of points) of the search window needed to calculate moving average. More... | |
| void | setWindowWidth (int windowWidth) |
| For details see getWindowWidth(). | |
 Public Member Functions inherited from com.nchart3d.NChart.NChartPointAnalyzer | |
| NChartPointAnalyzer () | |
| Create instance of point analyzer. | |
| NChartPoint[] | analyzePoints (NChartPoint[] points) |
| Perform the analytics on an array of points. More... | |
| NChartPoint[] | analyzePoints (NChartPoint[] points, int stateIndex) |
| Perform the analytics on an array of points. More... | |
| NChartValue | getStepDimension () |
| Key of the value that should be interpreted as step dimension. More... | |
| void | setStepDimension (NChartValue stepDimension) |
| For details see getStepDimension(). | |
| NChartValue | getValueDimension () |
| Key of the value that should be interpreted as height dimension. More... | |
| void | setValueDimension (NChartValue valueDimension) |
| For details see getValueDimension(). | |
Detailed Description
The NChartPeakDetector class provides methods to detect peak values inside the given point array.
The detection is based on the deviation from moving average.
Member Function Documentation
|
inline |
Threshold to search the peaks according to.
The default value is 0.3. See isAbsoluteThreshold() for details about how this value is interpreted.
|
inline |
Width (in number of points) of the search window needed to calculate moving average.
The default value is 5.
|
inline |
Flag determining if getThreshold() 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.
|
inline |
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.
|
inline |
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.
