doc -fix

matlab/tfgm/tf_tools/gen_gabmul_operator.m

@@ -3,10 +3,11 @@ function [gabmul_op, varargout] = gen_gabmul_operator(dgt, idgt, mask)
 % [gabmul_op, varargout] = gen_gabmul_operator(dgt, idgt, mask)
 %
 % Inputs:
-%     - dgt: Gabor transform operator
-%     - idgt: inverse Gabor  transform operator
-%     - mask: binary known mask
-% Output:
+%     - dgt: Gabor transform operator - handle
+%     - idgt: inverse Gabor  transform operator -handle
+%     - mask: Time-frequency mask
+%   see utils/generate_stft_operators.m for 'dgt' and 'idgt' operators
+% Outputs:
 %     - gabmul_op: gabor multiplier- handle function
 %
 % Author : A. Marina KREME

matlab/tfgm/tf_tools/generate_dgt_parameters.m

 function dgt_params = generate_dgt_parameters(win_type, approx_win_len, hop, nbins, sig_len)
 %% dgt_params = generate_dgt_parameters(win_type, approx_win_len, hop, nbins, sig_len)
 %
-% function that generates the dgt parameters.The functions used for
+%  Build structure of DGT parameter.The functions used for
 % the DGT are those of ltfat and not those of Matlab
+%  http://ltfat.github.io/doc/gabor
 
 %     Inputs:
-%      - win_type : str. It can be either a hanning (hann) or gauss window.
-%      - approx_win_len :  window length
-%      - hop :  length of time shift.
-%      - nbins: number of channels.
-%       -sig_len: length of input signal.
+%      - win_type (str) : It can be either a hanning (hann) or gauss window.
+%      - approx_win_len (int):  window length
+%      - hop (int):  length of time shift.
+%      - nbins (int): number of channels.
+%      -sig_len (int): length of input signal.
 %
 %   Outputs: dgt_params -  struct containing dgt parameters
-%
+%      - dgt_params.('win_type'): the window type (str)
+%      - dgt_params.('win'): the window array (nd-array)
+%      - dgt_params.('hop'): the hop size (int)
+%      - dgt_params.('n_bins'): the number of frequency bins (int)
+%      -dgt_params.('win_len'): the effective window length
+%                 (input window length rounded to the nearest power of two).
+%      -dgt_params.('info'): The structure info provides some information
+%                        about the compute window.
+%                       see  http://ltfat.github.io/doc/gabor/gabwin.html
+
+
 %
 % Author : A. Marina KREME
 % e-mail : ama-marina.kreme@lis-lab.fr/ama-marina.kreme@univ-amu.fr
@@ -21,6 +32,7 @@ function dgt_params = generate_dgt_parameters(win_type, approx_win_len, hop, nbi
 
 
 
+%%
 win_type = lower(win_type);
 
 if ~ischar(win_type)

matlab/tfgm/tf_tools/generate_signal_parameters.m

 function signal_params = generate_signal_parameters(fs, sig_len)
 %% GENERATE_SIGNAL_PARAMETERS
 % signal_params = generate_signal_parameters(fs, sig_len)
-% function that generates signals parameters (fs and sig_len)
+% Build structure of signals parameter
 %
 % Inputs:
-%       - fs: sampling frequency
-%       - sig_len :   signal length
+%       - fs (int): sampling frequency
+%       - sig_len(int) :   signal length
 % Outputs:
 %    - signal_params: structure that contains the signal parameters,
-% i.e. the sampling frequency and the length of the signal.
+%           - signal_params.('sig_len') : the signal length
+%            - signal_params.('fs') : the sampling frequency
 %
 % Author : A. Marina KREME
 % e-mail : ama-marina.kreme@lis-lab.fr/ama-marina.kreme@univ-amu.fr