comparison Problems/generateAudioDeclippingProblem.m @ 161:f42aa8bcb82f ivand_dev

debug and clean the SMALLbox Problems code

 %%  Generate Audio Declipping Problem
 %   
 %   generateAudioDeclippingProblem is part of the SMALLbox [1] and generates
 %   Audio declipping is a problem proposed in Audio Inpaining Toolbox and
 %   in [2]. 
+%
+%   The function takes as an optional input 
+%       soundfile   - name of the file
+%       clippingLevel - (default 0.6)
+%       windowSize  - 1D frame size (eg 512)
+%       overlap     - ammount of overlaping frames between 0 and 1
+%       wa,ws,wd    - analisys, synthesis and dictionary window functions
+%       
+%       Dict_fun    - function to be used to generate dictionary 
+%       redundancyFactor - overcompletness of dictionary (default 2)
+%   
+%   The function outputs the structure with following fields:
+%       original    - original signal
+%       clipped     - clipped signal
+%       clipMask    - mask indicating clipped samples
+%       clippingLevel - (default 0.6)
+%       Upper_Limit - maximum value of original data
+%       fs          - sample rate of the original signal in Hertz
+%       nbits       - the number of bits per sample
+%       sigma       - added noise level
+%       B           - dictionary to be used for sparse representation
+%       M           - measurement matrix (non-clipped data in b)
+%       b           - matrix of clipped frames
+%       m           - size od dictionary atom 
+%       n           - number of frames to be represented
+%       p           - number of atoms in dictionary
+%       windowSize  - 1D frame size (eg 512)
+%       overlap     - ammount of overlaping frames between 0 and 1
+%       wa,ws, wd   - analisys, synthesis and dictionary window functions
 %
 %   [1] I. Damnjanovic, M. E. P. Davies, and M. P. Plumbley "SMALLbox - an 
 %   evaluation framework for sparse representations and dictionary 
 %   learning algorithms," V. Vigneron et al. (Eds.): LVA/ICA 2010, 
 %   Springer-Verlag, Berlin, Germany, LNCS 6365, pp. 418-425

 data.wa = wa;
 data.wd = wd;
 
 data.fs = x.fs;
 data.nbits = x.nbits;
-data.Upper_Limit = max(solutiondata.XClean);
+data.Upper_Limit = max(solutionData.xClean);
 [data.m, data.n] = size(x_clip);
 data.p = windowSize*redundancyFactor; %number of dictionary elements 
 
 cd(TMPpath);