Document Actions

MPTK User Documentation

by broy — last modified 2011-06-29 10:06

The aim of the MPTK user part is to describe how to use MPTK on various platform (Linux, Mac OS X and Windows).


  • Warning

  • Most of the MPTK package is fairly stable now. However, we haven't reached version 1.0 yet. In particular, the data format of the "books" (the collections of atoms resulting from the MPTK processing) and of the XML dictionaries are bound to change in the upcoming versions. We are working on a system of backwards compatibility, but it is not ready yet: in the meantime, the formats may change with each new version (we will warn the users about it). We are conscious that this is a nuisance, and we are working on it.

  • Known bugs

    • Clipping sound output : MPTK currently use libsndfile library to manage the file I/O management in wave format and in the libsndfile implementation, this format is not protected against clipping, which may happen for some books and is not an artifact of the MPTK analysis. A message now warns you and indicates the gain you should apply on the input signal to avoid clipping.

New Features

  • Matlab interface

  • An interface with Matlab, using MEX-files, is now available. It includes utilities to read and write "books" (collections of atoms) and dictionary description files, as well as commands to perform Matching Pursuit decomposition and reconstruction.
    A tutorial is provided with the command GettingStarted.m, and two prototypes of graphical Matlab interfaces are now included to :
    1. Create dictionary description files
    2. Edit books of time-frequency atoms and perform various transformations such as pitch-shifting and time-stretching of 1D (audio) signals.

Features under development

  • Graphical User Interface:

A GUI based on Qt (open source version) is under development. It runs on all the MPTK supported platform, and will allow the creation of dictionary files. (feedback welcome !)

  • Change of the dictionaries parsing system:

The input dictionary in XML format is now parsed using XML. (feedback welcome !)

Using MPTK

Examples and available dictionaries

You can find examples and revelant Files for MPTK here