From fdac2ea526c8a84d47eb0664d889023a2403ba15 Mon Sep 17 00:00:00 2001 From: Jon Beniston Date: Sun, 13 Sep 2026 10:05:17 +0100 Subject: [PATCH] Describe spectrum averaging so that the mode and the count are set together Selecting an averaging mode does nothing with averagingValue left at 1, and its description said only "Averaging value". Say what the value is, that 1 is no averaging whatever the mode, that only the 1, 2, 5 series is available, and what 10 and 50 are good for. Co-Authored-By: Claude Fable 5.1 --- .../resources/webapi/doc/swagger/include/GLSpectrum.yaml | 9 +++++++-- swagger/sdrangel/api/swagger/include/GLSpectrum.yaml | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/sdrbase/resources/webapi/doc/swagger/include/GLSpectrum.yaml b/sdrbase/resources/webapi/doc/swagger/include/GLSpectrum.yaml index 2fe69e2a3..1571801da 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/GLSpectrum.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/GLSpectrum.yaml @@ -344,7 +344,8 @@ GLSpectrum: description: "Waterfall share for Gl spectrum." averagingMode: description: > - How successive FFTs are averaged + How successive FFTs are averaged. Selecting a mode does nothing on its own: the number of + FFTs it works over is averagingValue, which must be above 1 for any smoothing to happen. * 0 - no averaging * 1 - moving average * 2 - fixed average over each block @@ -355,7 +356,11 @@ GLSpectrum: maximum: 4 averagingValue: type: integer - description: "Averaging value for Gl spectrum." + description: > + Number of successive FFTs the averaging mode works over. 1 is no averaging whatever the + mode. Only 1, 2, 5, 10, 20, 50, 100 and so on are available and anything else is rounded + down to one of them. 10 smooths a noisy trace without hiding short signals; 50 or more + is for measuring a noise floor. linear: description: boolean type: integer diff --git a/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml b/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml index a728c017f..d59ec0f5f 100644 --- a/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml +++ b/swagger/sdrangel/api/swagger/include/GLSpectrum.yaml @@ -344,7 +344,8 @@ GLSpectrum: description: "Waterfall share for Gl spectrum." averagingMode: description: > - How successive FFTs are averaged + How successive FFTs are averaged. Selecting a mode does nothing on its own: the number of + FFTs it works over is averagingValue, which must be above 1 for any smoothing to happen. * 0 - no averaging * 1 - moving average * 2 - fixed average over each block @@ -355,7 +356,11 @@ GLSpectrum: maximum: 4 averagingValue: type: integer - description: "Averaging value for Gl spectrum." + description: > + Number of successive FFTs the averaging mode works over. 1 is no averaging whatever the + mode. Only 1, 2, 5, 10, 20, 50, 100 and so on are available and anything else is rounded + down to one of them. 10 smooths a noisy trace without hiding short signals; 50 or more + is for measuring a noise floor. linear: description: boolean type: integer