HistogramPeakEstimate¶
- MLModule¶
genre
author
package
dll
definition
keywords
Purpose¶
The module HistogramPeakEstimate calculates an estimate of peak positions of a histogram.
Details¶
The module computes peak positions of a smoothed version of the input histogram. Smoothing is performed by a non-linear diffusion filter with a linear diffusion model (see also SmoothHistogram).
A peak satisfies the following conditions:
The histogram value of a peak is higher than those of his neighbors.
The histogram value of a peak is at least
Minimum Height(to remove low peaks).The difference between the histogram value of a peak and those of the two points with distance
Distance for Slopeis at leastMinimum Slope(to remove flat peaks).
The positions of the peaks are returned, not the bin indices. All bin sizes are supported.
Example:
Windows¶
Default Panel¶
Input Fields¶
inHistogram¶
- name: inHistogram, type: HistogramObject(MLBase)¶
Output Fields¶
outPeakPositions¶
- name: outPeakPositions, type: CurveData(MLBase)¶
For accessing this object via scripting, see the Scripting Reference:
MLCurveDataWrapper.
outPeakXValues¶
- name: outPeakXValues, type: CurveData(MLBase)¶
For accessing this object via scripting, see the Scripting Reference:
MLCurveDataWrapper.
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
|
|
Visible Fields¶
Number of Iterations¶
- name: numOfIterations, type: Integer, default: 100, minimum: 0, maximum: 300, deprecated name: iterations¶
Sets the number of iteration steps for the diffusion filter.
The more steps, the longer the diffusion time.
Time Step Size¶
- name: stepSize, type: Double, default: 1, minimum: 0.01, maximum: 10¶
Sets the time step size.
Minimum Height¶
- name: minHeight, type: Double, default: 0¶
Sets the minimum histogram value of a peak candidate to be considered.
Minimum Slope¶
- name: minSlope, type: Double, default: 0¶
Sets the minimum difference between the histogram value of a peak to be considered and those of the two points with distance
Distance for Slope.
Distance for Slope¶
- name: distForSlope, type: Integer, default: 1, minimum: 0¶
Sets the distance between histogram positions that is used for slope estimation.
Number of Peaks¶
- name: numOfPeaks, type: Integer, persistent: no, deprecated name: NumOfPeaks¶
Shows the number of computed peaks.
Min Peak Postition¶
- name: minPeakPos, type: Integer, persistent: no¶
Shows the x-position of the first peak.
Max Peak Postition¶
- name: maxPeakPos, type: Integer, persistent: no¶
Shows the x-position of the last peak.