From 83edd92233a81c774d4aa8b0c37a1e839780414f Mon Sep 17 00:00:00 2001
From: Marina Kreme <amamarinak@gmail.com>
Date: Sat, 21 Nov 2020 06:48:28 +0100
Subject: [PATCH] add doc
---
matlab/tfgm/utils/plot_spectrogram.m | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/matlab/tfgm/utils/plot_spectrogram.m b/matlab/tfgm/utils/plot_spectrogram.m
index 3a4a29e..e0aa35a 100644
--- a/matlab/tfgm/utils/plot_spectrogram.m
+++ b/matlab/tfgm/utils/plot_spectrogram.m
@@ -1,14 +1,16 @@
function plot_spectrogram(x, dgt_params, signal_params, dgt, dynrange, clim)
%% plot_spectrogram(x, dgt_params, signal_params, dgt, dynrange, clim)
-% Function that displays the spectrogram of a signal
-%
+% Plot spectrogram of a signal
% Inputs:
-% - x: signal
-% - dgt_params: dgt parameters
+% - x (nd array): signal
+% - dgt_params (struct): dgt parameters (see tf_tools/generate_dgt_parameters.m)
% - signal_params: signal parameters
-% - dgt : Gabor transform operator
-% - dynrange : optional
-% - clim: optional
+% - dgt (handle) : DGT operator (see utils/get_stft_operators.m)
+% - dynrange (float) : Dynamic range to be displayed.
+% - clim (sequence): Min and max values for the colorbar.
+% If both 'clim' and 'dynrange' are specified,
+% then clim takes precedence.
+%
%
% Author : A. Marina KREME
%%
@@ -18,14 +20,12 @@ if size(x,2)==1
end
-if nargin==4
+ if nargin==4
dynrange=100;
c_max = max(db(x(:)));
clim = [c_max - dynrange, c_max];
end
-
-
plotdgtreal(x, dgt_params.hop, dgt_params.nbins, signal_params.fs,...,
'dynrange', dynrange,'clim',clim)
end
--
GitLab