diff --git a/matlab/README.md b/matlab/README.md index cbb77dd8d0fa740a1dc38f0b0351e8248c09cc7e..34dde278c95570b20e4c9cb36bb632fb5d5dce94 100644 --- a/matlab/README.md +++ b/matlab/README.md @@ -1,47 +1,57 @@ -# Matlab code for time-frequency fading +# Matlab code for time-frequency fading (TFF) -********************************************************************************************************************** -* author: A. Marina KREME -* institution: Institut de Math�matiques de Marseille (I2M) / Laboratoire d?Informatique et des syst�mes (LIS) - Aix-Marseille University, France. - -* date: May, 2020 -% revision date : -********************************************************************************************************************** -*********************************************************************************************************************** -* RECOMMENDATIONS: -* This toolbox is designed to work with -* Matlab R2017b (9.3.0.713579) and The Large Time Frequency Analysis Toolbox (LTFAT) which can be downloaded at https://ltfat.github.io -*********************************************************************************************************************** +# TFF: Time Frequency Fading ----------------------------- +TFF is a toolbox written in Matlab that allows to do time-frequency region +filtering out. More precisely, it is a Matlab implementation of the algorithms +from Time-frequency fading algorithms based on Gabor multipliers, by, +A. Marina Kr�m�, Valentin Emiya, Caroline Chaux, and Bruno Torr�sani, 2020. + +## Installation -# Foobar -Foobar is a Python library for dealing with word pluralization. -## Installation -Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar. -```bash -pip install foobar -``` ## Usage +See the documentation. + +## Bugs +Please report any bugs that you find through the skpomade GitLab project. +You can also fork the repository and create a merge request. + -```python -import foobar +## Source code +The source code of skpomade is available via its GitLab project. +You can clone the git repository of the project using the command: +git clone git@gitlab.lis-lab.fr:valentin.emiya/skpomade.git -foobar.pluralize('word') # returns 'words' -foobar.pluralize('goose') # returns 'geese' -foobar.singularize('phenomena') # returns 'phenomenon' -``` +## Copyright � 2019-2020 -## Contributing -Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. +Laboratoire d'Informatique et Syst�mes +Institut de Math�matiques de Marseille +Universit� d'Aix-Marseille -Please make sure to update tests as appropriate. -## License -[MIT](https://choosealicense.com/licenses/mit/) +## Contributors +A. Marina KREME + + + + +********************************************************************************************************************** +* author: A. Marina KREME +* institution: Institut de Math�matiques de Marseille (I2M) / Laboratoire d?Informatique et des syst�mes (LIS) - Aix-Marseille University, France. + +* date: May, 2020 +% revision date : +********************************************************************************************************************** +*********************************************************************************************************************** +* RECOMMENDATIONS: +* This toolbox is designed to work with +* Matlab R2017b (9.3.0.713579) and The Large Time Frequency Analysis Toolbox (LTFAT) which can be downloaded at https://ltfat.github.io +*********************************************************************************************************************** + +----------------------------