corrected the (buf) sine helpfiles

nix
Pierre Alexandre Tremblay 6 years ago
parent 47bc0928c6
commit a9cbb9fe5a

@ -47,31 +47,31 @@ ARGUMENT:: residual
The index of the buffer where the residual of the sinusoidal component will be reconstructed. The index of the buffer where the residual of the sinusoidal component will be reconstructed.
ARGUMENT:: bandwidth ARGUMENT:: bandwidth
The width in bins of the fragment of the fft window that is considered a normal deviation for a potential continuous sinusoidal track. It has an effect on CPU cost: the widest is more accurate but more computationally expensive. It is capped at (fftSize / 2) + 1. The number of bins used to resynthesises a peak. It has an effect on CPU cost: the widest is more accurate but more computationally expensive. It is capped at (fftSize / 2) + 1.
ARGUMENT:: detectionThreshold ARGUMENT:: detectionThreshold
The threshold in dB above which to consider a peak as a sinusoidal component from the normalized cross-correlation. The threshold in dB above which a magnitude peak is considered to be a sinusoidal component.
ARGUMENT:: birthLowThreshold ARGUMENT:: birthLowThreshold
The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the low end of the spectrum. It is interpolated across the spectrom until birthHighThreshold at half-Nyquist. The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the low end of the spectrum. It is interpolated across the spectrum until birthHighThreshold at half-Nyquist.
ARGUMENT:: birthHighThreshold ARGUMENT:: birthHighThreshold
The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the high end of the spectrum. It is interpolated across the spectrom until birthLowThreshold at DC. The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the high end of the spectrum. It is interpolated across the spectrum until birthLowThreshold at DC.
ARGUMENT:: minTrackLen ARGUMENT:: minTrackLen
The minimum duration, in spectral frames, for a sinusoidal track to be accepted as a partial. It allows to remove space-monkeys, but is more CPU intensive and might reject quick pitch material. The minimum duration, in spectral frames, for a sinusoidal track to be accepted as a partial. It allows to remove bubbly pitchy artefacts, but is more CPU intensive and might reject quick pitch material.
ARGUMENT:: trackingMethod ARGUMENT:: trackingMethod
The algorithm used to track the sinusoidal continuity between spectral frames. 0 is the default, "Greedy", and 1 is a more expensive "Munkres". footnote::reference here:: The algorithm used to track the sinusoidal continuity between spectral frames. 0 is the default, "Greedy", and 1 is a more expensive "Hungarian" one. footnote::Neri, J., and Depalle, P., "Fast Partial Tracking of Audio with Real-Time Capability through Linear Programming". Proceedings of DAFx-2018.::
ARGUMENT:: trackMagRange ARGUMENT:: trackMagRange
The frequency difference allowed for a track to diverge between frames, in Hertz. The amplitude difference allowed for a track to diverge between frames, in dB.
ARGUMENT:: trackFreqRange ARGUMENT:: trackFreqRange
The amplitude difference allowed for a track to diverge between frames, in dB. The frequency difference allowed for a track to diverge between frames, in Hertz.
ARGUMENT:: trackProb ARGUMENT:: trackProb
The probability of the tracking algorithm to find a track. At a value of 0, it will not try outside of the conditions. With a value of 1, it will match 100% of its peaks to a track. The probability of the tracking algorithm to find a track.
ARGUMENT:: windowSize ARGUMENT:: windowSize
The window size. As spectral differencing relies on spectral frames, we need to decide what precision we give it spectrally and temporally, in line with Gabor Uncertainty principles. http://www.subsurfwiki.org/wiki/Gabor_uncertainty The window size. As spectral differencing relies on spectral frames, we need to decide what precision we give it spectrally and temporally, in line with Gabor Uncertainty principles. http://www.subsurfwiki.org/wiki/Gabor_uncertainty

@ -22,31 +22,31 @@ ARGUMENT:: in
The input to be processed The input to be processed
ARGUMENT:: bandwidth ARGUMENT:: bandwidth
The width in bins of the fragment of the fft window that is considered a normal deviation for a potential continuous sinusoidal track. It has an effect on CPU cost: the widest is more accurate but more computationally expensive. It is capped at (fftSize / 2) + 1. The number of bins used to resynthesises a peak. It has an effect on CPU cost: the widest is more accurate but more computationally expensive. It is capped at (fftSize / 2) + 1.
ARGUMENT:: detectionThreshold ARGUMENT:: detectionThreshold
The threshold in dB above which to consider a peak as a sinusoidal component from the normalized cross-correlation. The threshold in dB above which a magnitude peak is considered to be a sinusoidal component.
ARGUMENT:: birthLowThreshold ARGUMENT:: birthLowThreshold
The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the low end of the spectrum. It is interpolated across the spectrom until birthHighThreshold at half-Nyquist. The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the low end of the spectrum. It is interpolated across the spectrum until birthHighThreshold at half-Nyquist.
ARGUMENT:: birthHighThreshold ARGUMENT:: birthHighThreshold
The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the high end of the spectrum. It is interpolated across the spectrom until birthLowThreshold at DC. The threshold in dB above which to consider a peak to start a sinusoidal component tracking, for the high end of the spectrum. It is interpolated across the spectrum until birthLowThreshold at DC.
ARGUMENT:: minTrackLen ARGUMENT:: minTrackLen
The minimum duration, in spectral frames, for a sinusoidal track to be accepted as a partial. It allows to remove space-monkeys, but is more CPU intensive and might reject quick pitch material. The minimum duration, in spectral frames, for a sinusoidal track to be accepted as a partial. It allows to remove bubbly pitchy artefacts, but is more CPU intensive and might reject quick pitch material.
ARGUMENT:: trackingMethod ARGUMENT:: trackingMethod
The algorithm used to track the sinusoidal continuity between spectral frames. 0 is the default, "Greedy", and 1 is a more expensive "Munkres". footnote::reference here:: The algorithm used to track the sinusoidal continuity between spectral frames. 0 is the default, "Greedy", and 1 is a more expensive "Hungarian" one. footnote::Neri, J., and Depalle, P., "Fast Partial Tracking of Audio with Real-Time Capability through Linear Programming". Proceedings of DAFx-2018.::
ARGUMENT:: trackMagRange ARGUMENT:: trackMagRange
The frequency difference allowed for a track to diverge between frames, in Hertz. The amplitude difference allowed for a track to diverge between frames, in dB.
ARGUMENT:: trackFreqRange ARGUMENT:: trackFreqRange
The amplitude difference allowed for a track to diverge between frames, in dB. The frequency difference allowed for a track to diverge between frames, in Hertz.
ARGUMENT:: trackProb ARGUMENT:: trackProb
The probability of the tracking algorithm to find a track. At a value of 0, it will not try outside of the conditions. With a value of 1, it will match 100% of its peaks to a track. The propensity of peaks to become enrolled into tracks.
ARGUMENT:: windowSize ARGUMENT:: windowSize
The window size. As sinusoidal estimation relies on spectral frames, we need to decide what precision we give it spectrally and temporally, in line with Gabor Uncertainty principles. http://www.subsurfwiki.org/wiki/Gabor_uncertainty The window size. As sinusoidal estimation relies on spectral frames, we need to decide what precision we give it spectrally and temporally, in line with Gabor Uncertainty principles. http://www.subsurfwiki.org/wiki/Gabor_uncertainty

Loading…
Cancel
Save