diff DL/Majorization Minimization DL/wrapper_mm_DL.m @ 219:4337e28183f1 luisf_dev

Modified help comments of wrapper_mm_DL.m, wrapper_mm_solver.m, SMALL_rlsdla.m & SMALL_AudioDenoise_DL_test_KSVDvsSPAMS.m. Moved wrapper_ALPS_toolbox from toolboxes to toolboxes/alps and added some extra help comments.

--- a/DL/Majorization Minimization DL/wrapper_mm_DL.m	Thu Mar 22 15:37:45 2012 +0000
+++ b/DL/Majorization Minimization DL/wrapper_mm_DL.m	Fri Mar 23 20:48:25 2012 +0000
@@ -3,30 +3,44 @@
 %
 %   Function gets as input Problem and Dictionary Learning (DL) structures 
 %   and outputs the learned Dictionary.
-
+%
 %   In Problem structure field b with the training set needs to be defined.
-   
+%   
 %   In DL structure field with name of the Dictionary update method needs 
 %   to be present. For the orignal version of MM algorithm the update 
 %   method should be:
-%       -   'mm_cn' - Regularized DL with column norm contraint
-%       -   'mm_fn' - Regularized DL with Frobenius norm contraint
+%       -   'mm_cn'   Regularized DL with column norm contraint
+%       -   'mm_fn'   Regularized DL with Frobenius norm contraint
 %   Alternatively, for comparison purposes the following Dictioanry update
 %   methods (which do not represent the optimised version of the algorithm)
 %   be used:
-%       -   'mod_cn' - Method of Optimized Direction
-%       -   'map-cn' - Maximum a Posteriory Dictionary update
-%       -   'ksvd-cn'- KSVD update
-%   
-%   DL.param.solver structure is also required. For the original version of
-%   MM algorithm, DL.param.solver.toolbox should be 'MMbox'. The parameters
-%   in DL.param.solver.param should be set accordingly. Type help
-%   wrapper_mm_solver for more details.
+%       -   'mod_cn'   Method of Optimized Direction
+%       -   'map-cn'   Maximum a Posteriory Dictionary update
+%       -   'ksvd-cn'  KSVD update
+%
+%   The structure DL.param with parameters is also required. These are:
+%       -   solver           structure with fields toolbox, solver and parameters. 
+%                            For the original version of the algorithm toolbox
+%                            should be 'MMbox' and solver field should be left
+%                            empty ''. Type HELP WRAPPER_MM_SOLVER for more
+%                            details on how to set the parameters.
+%       -   initdict         Initial Dictionary
+%       -   dictsize         Dictionary size (optional)
+%       -   iternum          Number of iterations (default is 40)
+%       -   iterDictUpdate   Number of iterations for Dictionary Update (default is 1000)
+%       -   epsDictUpdate    Stopping criterion for MM dictionary update (default = 1e-7)                         
+%       -   cvset            Dictionary constraint - 0 = Non convex ||d|| = 1, 1 = Convex ||d||<=1
+%                            (default is 0)
+%       -   coherence        Set at 1 if to perform decorrelation in every iteration
+%                            (default is 0)
+%       -   show_dict        Show dictonary every specified number of iterations
+% 
 %
 %   -   MM-DL - Yaghoobi, M.; Blumensath, T,; Davies M.; , "Dictionary
 %   Learning for Sparse Approximation with Majorization Method," IEEE
 %   Transactions on Signal Processing, vol.57, no.6, pp.2178-2191, 2009.
 
+%
 %   Centre for Digital Music, Queen Mary, University of London.
 %   This file copyright 2011 Ivan Damnjanovic.
 %