Peak |
Peak finder based on the Python SciPy package.
Inheritance HierarchyNamespace: Altaxo.Science.Spectroscopy.PeakSearching
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class PeakFinder
The PeakFinder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PeakFinder | Initializes a new instance of the PeakFinder class |
Properties| Name | Description | |
|---|---|---|
 | LeftBases | The position of the lowest valley point to the left of each peak. This array is only set if the parameter 'Prominence' was specified. |
| LeftEdges | Position of the first point to the left of each peak, whose value is different from the peak's value. This array is only set if the parameter 'PlateauSize' was specified. |
| LeftIps | The left intersection points of each peak. This array is only set if the parameter 'Width' was specified. |
| LeftThresholds | The left thresholds of each peak. This array is only set if the parameter 'Threshold' was specified. |
| PeakHeights | The peak height of each peak. This array is only set if the parameter Height was specified. |
| PeakPositions | The peak positions (indices of the y-array). This array is always set after a call to Execute. |
| PlateauSizes | The plateau sizes of each peak. This array is only set if the parameter PlateauSize was specified. |
| Prominences | The prominence values of each peak. This array is only set if the parameter 'Prominence' was specified. |
| RightBases | The position of the lowest valley point to the right of each peak. This array is only set if the parameter 'Prominence' was specified. |
| RightEdges | Position of the first point to the right of each peak, whose value is different from the peak's value. This array is only set if the parameter 'PlateauSize' was specified. |
| RightIps | The right intersection points of each peak. This array is only set if the parameter 'Width' was specified. |
| RightThresholds | The right thresholds of each peak. This array is only set if the parameter 'Threshold' was specified. |
| Warnings | The warnings during the execution of the peak finder algorithm. |
| WidthHeights | The height at which the width of each peak was determined. This array is only set if the parameter 'Width' was specified. |
| Widths | The width of each peak. This array is only set if the parameter 'Width' was specified. |
Methods| Name | Description | |
|---|---|---|
 | _arg_wlen_as_expected | Ensure argument `wlen` is of type `np.intp` and larger than 1. Used in `peak_prominences` and `peak_widths` |
| _local_maxima_1d | Find local maxima in a 1D array. This function finds all local maxima in a 1D array and returns the indices for their edges and midpoints(rounded down for even plateau sizes). |
| _peak_prominences | Calculate the prominence of each peak in a signal. |
| _peak_widths | Calculate the width of each each peak in a signal. |
| _select_by_peak_distance | Evaluate which peaks fulfill the distance condition. |
| _select_by_peak_threshold | |
| _select_by_property(Double, IReadOnlyListDouble, IReadOnlyListDouble) | |
| _select_by_property(Int32, IReadOnlyListDouble, IReadOnlyListDouble) | |
| _unpack_condition_args | |
| CombArray(Double, Boolean) | |
| CombArray(Int32, Boolean) | |
| CombArrays | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Execute(Double) | Find peaks inside a signal based on peak properties. This function takes a 1-D array and finds all local maxima by simple comparison of neighboring values. Optionally, a subset of these peaks can be selected by specifying conditions for a peak's properties. For this call, the properties of this PeakFinder instance will be used (that were before set with the Set.. methods). |
| Execute(Double, NullableDouble, NullableDouble, NullableDouble, NullableDouble, NullableDouble, NullableInt32, Double, NullableDouble) | Find peaks inside a signal based on peak properties. This function takes a 1-D array and finds all local maxima by simple comparison of neighboring values.Optionally, a subset of these peaks can be selected by specifying conditions for a peak's properties. |
| Execute(Double, Object, Object, NullableDouble, Object, Object, NullableInt32, Double, Object) | Find peaks inside a signal based on peak properties. This function takes a 1-D array and finds all local maxima by simple comparison of neighboring values.Optionally, a subset of these peaks can be selected by specifying conditions for a peak's properties. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Reset | |
| ResetDistance | Resets the distance parameter, so that there is no requirement to the distance of the peaks anymore. |
| ResetHeight | Resets the height parameter, so that there is no requirement to the height of the peaks anymore. |
| ResetPlateauSize | Resets the plateau size parameter, so that there is no requirement to the plateau size of the peaks anymore. |
| ResetProminence | Resets the prominence parameter, so that there is no requirement to the prominence values of the peaks anymore. |
| ResetRelativeHeight | Resets the relative height parameter to its default value of 0.5. |
| ResetThreshold | Resets the threshold parameter, so that there is no requirement to the threshold value of the peaks anymore. |
| ResetWidth | Resets the width parameter, so that there is no requirement to the width of the peaks anymore. |
| ResetWLen | Resets the width of the search window for the neighbouring values around a peak to the full spectral range. |
| SetDistance | Sets the minimal horizontal distance (>= 1) between neighbouring peaks, required for all peaks. Smaller peaks are removed first until the condition is fulfilled for all remaining peaks. |
| SetHeight(Double) | Sets the minimal height required for all peaks. |
| SetHeight(Double) | Sets the minimal height required for each peak. |
| SetHeight(ValueTupleDouble, Double) | Sets the minimal and maximal height required for all peaks. |
| SetHeight(ValueTupleDouble, Double) | Sets the minimal and maximal height required for each peak. |
| SetPlateauSize(Double) | Sets the minimal plateau size value required for all peaks. |
| SetPlateauSize(Double) | Sets the minimal plateau size value required for each peak. |
| SetPlateauSize(ValueTupleDouble, Double) | Sets the minimal and maximal plateau size value required for all peaks. |
| SetPlateauSize(ValueTupleDouble, Double) | Sets the minimal and maximal plateau size value required for each peak. |
| SetProminence(Double) | Sets the minimal prominence value required for all peaks. Prominence is defined as the smaller of the two difference values between the peak height and the height of the neighbouring valleys. |
| SetProminence(Double) | Sets the minimum prominence values required for each peak. Prominence is defined as the smaller of the two difference values between the peak height and the height of the neighbouring valleys. |
| SetProminence(ValueTupleDouble, Double) | Sets the minimal and maximal prominence values required for all peaks. Prominence is defined as the smaller of the two difference values between the peak height and the height of the neighbouring valleys. |
| SetProminence(ValueTupleDouble, Double) | Sets the minimal and maximal prominence values required for each peak. Prominence is defined as the smaller of the two difference values between the peak height and the height of the neighbouring valleys. |
| SetRelativeHeight | Sets the relative height value that is used to determine the width of the peaks. The width of a peak is determined at the y-value, which is (prominence x relative height) below the peak's y-value. |
| SetThreshold(Double) | Sets the minimal threshold value required for all peaks. Threshold is defined as minimum difference value between the peak height and its immediate neightbouring points. |
| SetThreshold(Double) | Sets the minimal threshold value required for each peak. Threshold is defined as minimum difference value between the peak height and its immediate neightbouring points. |
| SetThreshold(ValueTupleDouble, Double) | Sets the minimal and maximal threshold value required for all peaks. Threshold is defined as minimum difference value between the peak height and its immediate neightbouring points. |
| SetThreshold(ValueTupleDouble, Double) | Sets the minimal and maximal threshold value required for each peak. Threshold is defined as minimum difference value between the peak height and its immediate neightbouring points. |
| SetWidth(Double) | Sets the minimal width value required for all peaks. The width of a peak is determined at the y-value, which is (prominence x relative height) less than the peak's y-value. |
| SetWidth(Double) | Sets the minimal width value required for each peak. The width of a peak is determined at the y-value, which is (prominence x relative height) less than the peak's y-value. |
| SetWidth(ValueTupleDouble, Double) | Sets the minimal and maximal width value required for all peaks. The width of a peak is determined at the y-value, which is (prominence x relative height) less than the peak's y-value. |
| SetWidth(ValueTupleDouble, Double) | Sets the minimal and maximal width values required for each peak. The width of a peak is determined at the y-value, which is (prominence x relative height) less than the peak's y-value. |
| SetWLen | Sets the width of the search window for the neighbouring values around a peak (in points). Used for calculation of the peaks prominences, thus it is only used if one of the parameters 'prominence' or 'width' is given. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also