MPTK command line FAQ

Usage:

                        ... [residualFILE.wav]

Synopsis:

Mandatory arguments:

-n<N>, --num-iter=<N>|--num-atoms=<N> Stop after N iterations.
AND/OR -s<SNR>, --snr=<SNR> Stop when the SNR value SNR is reached. If both options are used together, the algorithm stops as soon as either one is reached.
(sndFILE.wav|-) The signal to analyze or stdin (in WAV format).
(bookFILE.bin|-) The file to store the resulting book of atoms, or stdout.

Optional arguments:

-R<N>, --report-hit=<N> Report some progress info (in stderr) every N iterations.
-S<N>, --save-hit=<N> Save the output files every N iterations.
-T<N>, --snr-hit=<N> Test the SNR every N iterations only (instead of each iteration).
-p<double>, --preemp=<double> Pre-emphasize the input signal with coefficient <double>.
residualFILE.wav The residual signal after subtraction of the atoms.
-q, --quiet No text output.
-v, --verbose Verbose.
-V, --version Output the version and exit.
-h, --help This help.

Usage:

mpview [options] (bookFILE.bin|-) tfmapFILE.flt

Synopsis:

Makes a time-frequency pixmap fill it with the time-frequency representation of the atoms contained in the book file bookFile.bin and write it to the file tfmapFILE.flt as a raw sequence of floats. The pixmap size is 640x480 pixels unless option –size is used.

Mandatory arguments:

(bookFILE.bin|-) A book of atoms, or stdin.
tfmapFILE.flt The file where to write the pixmap in float.
Optional arguments:
-s, --size=<numCols>x<numRows> : change the size of the pixmap.
-q, --quiet No text output.
-v, --verbose Verbose.
-V, --version Output the version and exit.
-h, --help This help.

Synopsis:

Displays a book in a pixmap of numCols x numRows pixels Returns nonzero in case of failure, zero otherwise.

Usage:

(sndFILE.wav|-) (bookFILE) [residualFILE.wav]

Synopsis:

Mandatory arguments:

The first line of the file should indicate the number of rows and the number of columns, and the following lines should give space separated values, with a line break after each row.

EXAMPLE:
2 3
0.92 0.38 0.71
0.71 0.77 1.85

-n<N>, --num-iter=<N>|--num-atoms=<N> Stop after N iterations. AND/OR -s<SNR>, --snr=<SNR> Stop when the SNR value SNR is reached.
If both options are used together, the algorithm stops as soon as either one is reached.
(sndFILE.wav|-) The signal to analyze or stdin
(in WAV format).
(bookFILE) The base name of the files to store the books of atoms_n corresponding to the N estimated sources. These N books will be named bookFILE_n.bin, n=[0,...,N-1].

Optional arguments:

If no dictionary is given, a default dictionary is used. (Use -v to see the structure of the default dictionary reported in the verbose information.)
-E<FILE>, --energy-decay=<FILE> Save the energy decay as doubles to file FILE.
-Q<FILE>, --src-sequence=<FILE> Save the source sequence as unsigned short ints to file FILE.
-R<N>, --report-hit=<N> Report some progress info (in stderr) every N iterations.
-S<N>, --save-hit=<N> Save the output files every N iterations.
-T<N>, --snr-hit=<N> Test the SNR every N iterations only (instead of each iteration). residualFILE.wav The residual signal after subtraction of the atoms.
-q, --quiet No text output.
-v, --verbose Verbose.
-V, --version Output the version and exit.
-h, --help This help.

Usage:

Synopsis:

Rebuilds a signal reconsFile.wav from the atoms contained in the book file bookFile.bin. An optional residual can be added.

Mandatory arguments:

(bookFILE.bin|-) A book of atoms, or stdin.
(reconsFILE.wav|-) A file to store the rebuilt signal, or stdout
(in WAV format).

Optional arguments:

residualFILE.wav A residual signal that was obtained from a Matching Pursuit decomposition.
-q, --quiet No text output.
-v, --verbose Verbose.
-V, --version Output the version and exit.
-h, --help This help.

Usage:

mpcat (book1.bin|-) (book2.bin|-) ... (bookN.bin|-) (bookOut.bin|-)

Synopsis:

Concatenates the N books book1.bin...bookN.bin into the book file bookOut.bin.

Mandatory arguments:

(bookN.bin|-) At least 2 books (or stdin) to concatenate.
(bookOut.bin|-) A book where to store the concatenated books, or stdout

Optional arguments:

-f, --force Force the overwriting of bookOut.bin.
-q, --quiet No text output.
-v, --verbose Verbose.
-V, --version Output the version and exit.
-h, --help This help.

Usage:

mpf --PROPERTY1=[min:max] ... --PROPERTY_N=[min:max] (bookIn.bin|-) ...
[bookYes.bin|-] [bookNo.bin]

Synopsis:

Filters the atoms contained in bookIn.bin (or stdin), stores those which satisfy the indicated properties in bookYes.bin (or stdout) and the others in bookNo.bin.

Mandatory arguments:

(bookIn.bin|-) A book of input atoms, or stdin.

Optional arguments:

(bookYes.bin|-) A file (or stdout) to store the book of atoms which satisfy the indicates properties. bookNo.bin A file to store a book of atoms which do not satisfy the indicated properties.
If no output files are given, the atoms are just counted and their number is reported in stderr.

One or more of the following switches:
    --index=[min:max] / -i [min:max] : keep the atoms ordered from min to maxin the book
    --length=[min:max] / -l [min:max] : keep a specific range of atom lengths(in number of samples)
    --Length=[min:max] / -L [min:max] : keep a specific range of atom lengths(in seconds)
    --position=[min:max] / -p [min:max] : keep a specific range of atom positions(in number of samples)
    --Position=[min:max] / -P [min:max] : keep a specific range of atom positions(in seconds)
    --freq=[min:max] / -f [min:max] : keep a specific frequency range (innormalized values between 0 and 0.5)
    --Freq=[min:max] / -F [min:max] : keep a specific frequency range (in Hz)
    --amp=[min:max] / -a [min:max] : keep a specific range of amplitudes
    --chirp=[min:max] / -c [min:max] : keep a specific range of chirp factors

The intervals can exclude the min or max value by using reverted braces, e.g. ]min:max] will exclude the min value. The intervals can be negated with prepending the ’^’ character, e.g. ^[min:max].

The atom’s type can be tested with:
    --type=gabor|harmonic|dirac|anywave / -t gabor|harmonic|dirac|anywave (The chirp type is not provided: a chirp atom is a gabor atom with a non-null chirp rate.)

Other optional arguments are:
    -q, --quiet No text output.
    -v, --verbose Verbose.
    -V, --version Output the version and exit.
    -h, --help This help.

Example:

Take all the atoms with a frequency lower than 50Hz and higher than 1000Hz among the first 100 atoms of bookIn.bin, store them in bookYes.bin and store all the others in bookNo.bin:
mpf --index=[0:100[ --Freq=^[50:1000] bookIn.bin bookYes.bin bookNo.bin

Note:

Only one instance of each property is allowed. More complicated domains can be elaborated using pipes.