From 6ec01ae2a310eee16a44e5a338f29d9272c7c4e7 Mon Sep 17 00:00:00 2001
From: Marina Kreme <amamarinak@gmail.com>
Date: Sat, 21 Nov 2020 06:59:02 +0100
Subject: [PATCH] add doc

---
 matlab/tfgm/utils/sdr.m | 5 ++---
 matlab/tfgm/utils/snr.m | 6 +++---
 2 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/matlab/tfgm/utils/sdr.m b/matlab/tfgm/utils/sdr.m
index e94493d..96c62ed 100644
--- a/matlab/tfgm/utils/sdr.m
+++ b/matlab/tfgm/utils/sdr.m
@@ -5,9 +5,8 @@ function SDR = sdr(x_ref, x_est)
 % and estimated signal
 %
 % Inputs:
-%    - x_ref: target signal
-%    - x_est: estimated signal
-%
+%    - x_ref (nd array): Reference  signal
+%    - x_est (nd array): Estimation of the reference signal
 % Output:
 %    -SDR: Signal to Distorsion Ratio in dB
 %
diff --git a/matlab/tfgm/utils/snr.m b/matlab/tfgm/utils/snr.m
index b6d2656..ecd60b1 100644
--- a/matlab/tfgm/utils/snr.m
+++ b/matlab/tfgm/utils/snr.m
@@ -5,11 +5,11 @@ function SNR = snr(x_signal, x_noise)
 % of a desired signal to the level of background noise.
 % 
 % Inputs:
-%     -x_signal: target signal
-%     - x_noise: noise signal
+%     -x_signal(nd array): target signal
+%     - x_noise (nd array): noise signal
 %     
 % Output:
-%     - SNR : SNR
+%     - SNR (float): SNR
 % Author: Marina KREME
 %%
 
-- 
GitLab