/phaseret

Phase ReTrieval for time-frequency representations

Primary LanguageCGNU General Public License v3.0GPL-3.0

PhaseReT

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

Requirements

The toolbox depends on LTFAT - Large Time-Frequency Analysis Toolbox.

Further, some functions require additional dependencies:

Instalation and usage

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 MEX interfaces are already compiled.

If you are using the pre-compiled Windows package, the next step is not necessary.

The mex interfaces can be compiled by running

phaseretmex;

from within Matlab/Octave command line. Note that the FFTW library has to be installed by e.g. apt-get install libfftw3-dev on Debian-based systems. On Windows, this has to be done manually by downloading the archive from here and placing libfftw3-3.dll and libfftw3f-3.dll to the [path_to_phaseret]/mex subdirectory).

To start the toolbox automatically add the following lines

addpath(path_to_ltfat);
addpath(path_to_phaseret);
ltfatstart;
phaseretstart;

to your startup script Matlab Octave.

Note that pre-compiled packages for Windows can be downloaded from the GitHub release page.

Documentation

Online documentation is available here.

References

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.

License

PhaseReT is distributed under terms of GPL3