
COMPBox v10 README
April 19, 2015

This package extends the work of Dr. R. Rubinstein that implemented OMP and K-SVD in his OMPbox and KSVDbox packages (http://www.cs.technion.ac.il/~ronrubin/software.html).
These packages are included in COMPbox.

Use of this package:
-------------------
If you use this package, please include a citation in your work.
Make sure to cite the following works if you need the OMP for complex signals:

  [1] M. Elad, R. Rubinstein, and M. Zibulevsky, "Efficient Implementation
      of the K-SVD Algorithm using Batch Orthogonal Matching Pursuit",
      Technical Report - Computer Science, Technion, April 2008.
	  
  [2] J. S. Turek, M. Elad, and I. Yavneh, "Clutter Mitigation in 
      Echocardiography using Sparse Signal Separation", International 
      Journal on Biomedical Imaging, April 2015.
	  
If you need the K-SVD for complex signals, please include the following work:

  [3] M. Aharon, M. Elad, and A.M. Bruckstein, "The K-SVD: An Algorithm
      for Designing of Overcomplete Dictionaries for Sparse Representation", 
	  IEEE Trans. On Signal Processing, Vol. 54, no. 11, pp. 4311-4322, November 2006.


COMPBox installation:
--------------------

1. Unpack the contents of the compressed file to a new directory, named e.g. "compbox".
2. If you have not done so before, configure Matlab's MEX compiler by entering
    >> mex -setup
   prior to using MAKE. For optimal performance, it is recommended that you select a compiler
   that performs optimizations. For instance, in Windows, MS Visual Studio is preferred to Lcc.
3. Within Matlab, navigate to the COMPBox directory, and then to the "private" directory within it,
   and enter MAKE to run the compilation script.
4. Add the COMPBox package directory to the Matlab path (you can use the ADDPATH command for this).
   Do not add the private directory to the path.


COMPBox quick start:
-------------------

1. Enter "ompdemo" at the Matlab command prompt to run a short demo of the package.
2. Enter "ompspeedtest" to test the speed of the various OMP implementations.
3. For a complete list of functions in the package, enter
 >> help COMPBox
This assumes the package was installed to a directory named "COMPBox". If not, replace COMPBox
in the above with the (unqualified) name of the COMPBox installation directory.

Also see faq.txt for some frequently asked questions about the package.
