From f63390590c9df0c340d5047b318543ab4eac5691 Mon Sep 17 00:00:00 2001 From: Alex Harker Date: Fri, 23 Jun 2023 08:22:13 +0100 Subject: [PATCH] Correct argument numbering (and documentation) --- FrameLib_Objects/Vector/FrameLib_Peaks.cpp | 4 ++-- .../docs/refpages/framelib-ref/fl.peaks~.maxref.xml | 8 ++++++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/FrameLib_Objects/Vector/FrameLib_Peaks.cpp b/FrameLib_Objects/Vector/FrameLib_Peaks.cpp index 4585a2f1f..5299126fb 100644 --- a/FrameLib_Objects/Vector/FrameLib_Peaks.cpp +++ b/FrameLib_Objects/Vector/FrameLib_Peaks.cpp @@ -35,11 +35,11 @@ FrameLib_Peaks::FrameLib_Peaks(FrameLib_Context context, const FrameLib_Paramete mParameters.addEnumItem(kParabolic, "parabolic", true); mParameters.addEnumItem(kParabolicLog, "parabolic_log"); - mParameters.addEnum(kBoundaries, "boundaries", 4); + mParameters.addEnum(kBoundaries, "boundaries", 5); mParameters.addEnumItem(kMinimum, "minimum"); mParameters.addEnumItem(kMidpoint, "midpoint"); - mParameters.addBool(kAlwaysDetect, "always_detect", true, 5); + mParameters.addBool(kAlwaysDetect, "always_detect", true, 6); mParameters.set(serialisedParameters); diff --git a/Packaging/Max/FrameLib/docs/refpages/framelib-ref/fl.peaks~.maxref.xml b/Packaging/Max/FrameLib/docs/refpages/framelib-ref/fl.peaks~.maxref.xml index d36241dbe..1f79f2eb9 100644 --- a/Packaging/Max/FrameLib/docs/refpages/framelib-ref/fl.peaks~.maxref.xml +++ b/Packaging/Max/FrameLib/docs/refpages/framelib-ref/fl.peaks~.maxref.xml @@ -90,6 +90,14 @@ This argument sets the edges parameter:

Sets the edge behaviour for peak detection:

[0] - pad - values beyond the edges of the input are read as the padding value.[1] - extend - the edge values are extended infinitely in either direction.[2] - wrap - values are read as wrapped or cyclical.[3] - fold - values are folded at edges without repetition of the edge values.[4] - mirror - values are mirrored at edges with the edge values repeated.

(default: pad) + + + Sets the method for refining peak values + + + This argument sets the refine parameter:

Sets the method for refining peak values:

[0] - off - return the peak value without refinement.[1] - parabolic - apply parabolic interpolation to the three values around the peak.[2] - parabolic_log - apply parabolic interpolation to the log of the three values around the peak.

Note that parabolic_log is suitable for interpolating linear amplitudes.

(default: parabolic) + + Sets the method for selecting the boundaries between peaks