ltfat / phaseret Goto Github PK

PhaseReT is a Matlab/GNU Octave toolbox collecting implementations of phase-reconstruction algorithms for complex time-frequency representations (like STFT).

The toolbox depends on LTFAT - Large Time-Frequency Analysis Toolbox. LTFAT can be installed in various ways. Please follow instructions at the LTFAT release page.

Further, some functions require additional dependencies:

• decolbfgs requires minFunc

On Matlab in Windows, it is recommended to use the pre-compiled binary release package (phaseret-[version]-win64.zip) from the GitHub release page.

For other configurations, download the source-only package (phaseret-[version]-src.tgz).

In order to use the toolbox it is necessary to run

phaseretstart;

from the [path_to_phaseret] directory. The command checks whether LTFAT has already been started and whether phaseret MEX interfaces are already compiled.

In order to compile the missing mex files run

phaseretmex;

from within Matlab/Octave command line.

Online documentation is available here.

If you use this toolbox/library in your research, please cite

Z. Prusa: The Phase Retrieval Toolbox, AES Int. Conf. On Semantic Audio, Erlangen, Germany, June, 2017 preprint.

@inproceedings{ltfatnote045,
 year={2017},
 month={June},
 title={{The Phase Retrieval Toolbox}},
 author={Zden\v{e}k Pr\r{u}\v{s}a},
 booktitle = {{AES} International Conference On Semantic Audio},
 address = {Erlangen, Germany}}

and/or relevant references found in help of the individual files.

PhaseReT is distributed under terms of GPL3