diff --git a/doc/AmpGate.rst b/doc/AmpGate.rst index 4a95c64..b3e34d5 100644 --- a/doc/AmpGate.rst +++ b/doc/AmpGate.rst @@ -7,7 +7,7 @@ :description: Absolute amplitude threshold gate detector on a realtime signal :discussion: - AmpGate outputs a audio-rate, single-channel signal that is either 0, indicating the gate is closed, or 1, indicating the gate is open. The gate detects an onset (opens) when the internal envelope follower (controlled by ``rampUp`` and ``rampDown``) goes above a specified ``onThreshold`` (in dB) for at least ``minLengthAbove`` samples. The gate will stay open until the envelope follower goes below ``offThreshold`` (in dB) for at least ``minLengthBelow`` samples, which triggers an offset. + AmpGate outputs an audio-rate, single-channel signal that is either 0, indicating the gate is closed, or 1, indicating the gate is open. The gate detects an onset (opens) when the internal envelope follower (controlled by ``rampUp`` and ``rampDown``) goes above a specified ``onThreshold`` (in dB) for at least ``minLengthAbove`` samples. The gate will stay open until the envelope follower goes below ``offThreshold`` (in dB) for at least ``minLengthBelow`` samples, which triggers an offset. The latency between the input and the output is **max(minLengthAbove + lookBack, max(minLengthBelow,lookAhead))**. diff --git a/doc/AudioTransport.rst b/doc/AudioTransport.rst index 489193d..d25c2f0 100644 --- a/doc/AudioTransport.rst +++ b/doc/AudioTransport.rst @@ -26,7 +26,7 @@ :control hopSize: - The window hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size but low overlap may create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size, but low overlap may create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/BufAmpFeature.rst b/doc/BufAmpFeature.rst index 0487ad7..f82d45f 100644 --- a/doc/BufAmpFeature.rst +++ b/doc/BufAmpFeature.rst @@ -13,11 +13,11 @@ :control source: - The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. + The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. :control startFrame: - Where in the srcBuf should the slicing process start, in sample. + Where in the srcBuf should the slicing process start, in samples. :control numFrames: @@ -33,7 +33,7 @@ :control features: - The index of the buffer where the amplitude differential feature will be copied to. + The buffer where the amplitude differential feature will be copied to. :control fastRampUp: diff --git a/doc/BufAmpGate.rst b/doc/BufAmpGate.rst index 7718895..5d8f9b7 100644 --- a/doc/BufAmpGate.rst +++ b/doc/BufAmpGate.rst @@ -36,7 +36,7 @@ :control indices: - The buffer to write the gate information into. Buffer will be resized appropriately so each frame contains an onset (opening) position on channel 0 and the corresponding offset (closing) position on channel 1 (both in samples). The buffer will have as many frames as gate events detected. + The buffer to write the gate information into. Buffer will be resized appropriately so that each frame contains an onset (opening) position on channel 0 and the corresponding offset (closing) position on channel 1 (both in samples). The buffer will have as many frames as gate events detected. :control rampUp: diff --git a/doc/BufAmpSlice.rst b/doc/BufAmpSlice.rst index c2590a0..96394ca 100644 --- a/doc/BufAmpSlice.rst +++ b/doc/BufAmpSlice.rst @@ -8,18 +8,18 @@ :discussion: FluidBufAmpSlice is based on two envelope followers on a high-passed version of the signal: one slow that gives the trend, and one fast. Each has features that will interact. The example code below is unfolding the various possibilities in order of complexity. - The process will return a buffer which contains indices (in sample) of estimated starting points of different slices. + The process will return a buffer which contains indices (in samples) of estimated starting points of different slices. :output: Nothing, as the destination buffer is declared in the function call. :control source: - The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. + The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. :control startFrame: - Where in the srcBuf should the slicing process start, in sample. + Where in the srcBuf should the slicing process start, in samples. :control numFrames: @@ -35,7 +35,7 @@ :control indices: - The index of the buffer where the indices (in sample) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis. + The buffer where the indices (in samples) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis. :control fastRampUp: diff --git a/doc/BufAudioTransport.rst b/doc/BufAudioTransport.rst index a9e67ab..5407f4a 100644 --- a/doc/BufAudioTransport.rst +++ b/doc/BufAudioTransport.rst @@ -67,7 +67,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/BufChroma.rst b/doc/BufChroma.rst index 552525e..cce64ac 100644 --- a/doc/BufChroma.rst +++ b/doc/BufChroma.rst @@ -15,11 +15,11 @@ :control source: - The index of the buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially. :control startFrame: - Where in the srcBuf should the process start, in sample. + Where in the srcBuf should the process start, in samples. :control numFrames: @@ -63,7 +63,7 @@ :control hopSize: - The window hop size. As chroma description relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As chroma description relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/BufCompose.rst b/doc/BufCompose.rst index 8071832..20bbd47 100644 --- a/doc/BufCompose.rst +++ b/doc/BufCompose.rst @@ -8,7 +8,7 @@ A utility for manipulating the contents of buffers. :discussion: - This object is the swiss army knife for manipulating buffers and their contents. By specifying ranges of samples and channels to copy, as well as destination and source gains it can provide a powerful interface for performing actions such as a Left/Right to Mid/Side conversion and mixing down multichannel audio + This object is a low-level tool for manipulating buffers and their contents. By specifying ranges of samples and channels to copy, as well as destination and source gains it can provide a powerful interface for performing actions such as a Left/Right to Mid/Side conversion and mixing down multichannel audio :process: This method triggers the compositing. diff --git a/doc/BufHPSS.rst b/doc/BufHPSS.rst index a059a8d..050e40a 100644 --- a/doc/BufHPSS.rst +++ b/doc/BufHPSS.rst @@ -29,7 +29,7 @@ :control source: - The index of the buffer to use as the source material. The channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material. The channels of multichannel buffers will be processed sequentially. :control startFrame: @@ -49,15 +49,15 @@ :control harmonic: - The index of the buffer where the extracted harmonic component will be reconstructed. + The buffer where the extracted harmonic component will be reconstructed. :control percussive: - The index of the buffer where the extracted percussive component will be reconstructed. + The buffer where the extracted percussive component will be reconstructed. :control residual: - The index of the buffer where the residual component will be reconstructed in mode 2. + The buffer where the residual component will be reconstructed in mode 2. :control harmFilterSize: @@ -96,7 +96,7 @@ :control hopSize: - The hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size but low overlap may create audible artefacts. + The hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size, but low overlap may create audible artefacts. :control fftSize: diff --git a/doc/BufLoudness.rst b/doc/BufLoudness.rst index 05f1f68..f4689a7 100644 --- a/doc/BufLoudness.rst +++ b/doc/BufLoudness.rst @@ -18,11 +18,11 @@ :control source: - The index of the buffer to use as the source material to be described. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be described. The different channels of multichannel buffers will be processed sequentially. :control startFrame: - Where in the srcBuf should the process start, in sample. + Where in the srcBuf should the process start, in samples. :control numFrames: @@ -54,11 +54,11 @@ :control windowSize: - The size of the window on which the computation is done. By default 1024 to be similar with all other FluCoMa objects, the EBU specifies 400ms, which is 17640 samples at 44100. + The size of the window on which the computation is done. By default, 1024 to be similar with all other FluCoMa objects, the EBU specifies 400ms, which is 17640 samples at 44100. :control hopSize: - How much the buffered window moves forward, in samples. By default 512 to be similar with all other FluCoMa objects, the EBU specifies 100ms, which is 4410 samples at 44100. + How much the buffered window moves forward, in samples. By default, 512 to be similar with all other FluCoMa objects, the EBU specifies 100ms, which is 4410 samples at 44100. :control padding: diff --git a/doc/BufMFCC.rst b/doc/BufMFCC.rst index e537fbc..2dd4648 100644 --- a/doc/BufMFCC.rst +++ b/doc/BufMFCC.rst @@ -18,7 +18,7 @@ :control source: - The index of the buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially. :control startFrame: @@ -66,7 +66,7 @@ :control hopSize: - The window hop size. As MFCC computation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As MFCC computation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/BufMelBands.rst b/doc/BufMelBands.rst index 4b97b04..99e4bee 100644 --- a/doc/BufMelBands.rst +++ b/doc/BufMelBands.rst @@ -20,7 +20,7 @@ :control source: - The index of the buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially. :control startFrame: @@ -68,7 +68,7 @@ :control hopSize: - The window hop size. As this analysis relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As this analysis relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/BufNMF.rst b/doc/BufNMF.rst index 22719f6..7303008 100644 --- a/doc/BufNMF.rst +++ b/doc/BufNMF.rst @@ -32,11 +32,11 @@ :control source: - The index of the buffer to use as the source material to be decomposed through the NMF process. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be decomposed through the NMF process. The different channels of multichannel buffers will be processed sequentially. :control startFrame: - Where in the srcBuf should the NMF process start, in sample. + Where in the srcBuf should the NMF process start, in samples. :control numFrames: @@ -52,7 +52,7 @@ :control resynth: - The index of the buffer where the different reconstructed components will be reconstructed. The buffer will be resized to ``components * numChannelsProcessed`` channels and ``sourceDuration`` length. If ``nil`` is provided, the reconstruction will not happen. + The buffer where the different reconstructed components will be reconstructed. The buffer will be resized to ``components * numChannelsProcessed`` channels and ``sourceDuration`` length. If ``nil`` is provided, the reconstruction will not happen. :control resynthMode: @@ -60,7 +60,7 @@ :control bases: - The index of the buffer where the different bases will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no bases will be returned. + The buffer where the different bases will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no bases will be returned. :control basesMode: @@ -79,7 +79,7 @@ :control activations: - The index of the buffer where the different activations will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no activation will be returned. + The buffer where the different activations will be written to and/or read from: the behaviour is set in the following argument. If ``nil`` is provided, no activation will be returned. :control actMode: @@ -110,7 +110,7 @@ :control hopSize: - The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/BufNMFSeed.rst b/doc/BufNMFSeed.rst index fdaa5ab..3bf6cc0 100644 --- a/doc/BufNMFSeed.rst +++ b/doc/BufNMFSeed.rst @@ -58,7 +58,7 @@ :control hopSize: - The window hop size. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/BufNoveltyFeature.rst b/doc/BufNoveltyFeature.rst index 13d25d6..4dec48a 100644 --- a/doc/BufNoveltyFeature.rst +++ b/doc/BufNoveltyFeature.rst @@ -20,11 +20,11 @@ :control source: - The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. + The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. :control startFrame: - Where in the srcBuf should the slicing process start, in sample. + Where in the srcBuf should the slicing process start, in samples. :control numFrames: @@ -40,7 +40,7 @@ :control features: - The index of the buffer where the novelty feature will be written. + The buffer where the novelty feature will be written. :control algorithm: @@ -77,7 +77,7 @@ :control hopSize: - The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/BufNoveltySlice.rst b/doc/BufNoveltySlice.rst index 9d5bb21..e69b306 100644 --- a/doc/BufNoveltySlice.rst +++ b/doc/BufNoveltySlice.rst @@ -7,7 +7,7 @@ :discussion: A novelty curve is derived from running a kernel across the diagonal of the similarity matrix, and looking for peaks of changes. It implements the seminal results published in 'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote. - The process will return a buffer which contains indices (in sample) of estimated starting points of different slices. + The process will return a buffer which contains indices (in samples) of estimated starting points of different slices. .. only_in:: sc @@ -19,11 +19,11 @@ :control source: - The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. + The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. :control startFrame: - Where in the srcBuf should the slicing process start, in sample. + Where in the srcBuf should the slicing process start, in samples. :control numFrames: @@ -39,7 +39,7 @@ :control indices: - The index of the buffer where the indices (in sample) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis. + The buffer where the indices (in samples) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis. :control algorithm: @@ -84,7 +84,7 @@ :control hopSize: - The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/BufOnsetFeature.rst b/doc/BufOnsetFeature.rst index 97ef8b8..5049ba9 100644 --- a/doc/BufOnsetFeature.rst +++ b/doc/BufOnsetFeature.rst @@ -18,11 +18,11 @@ :control source: - The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. + The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. :control startFrame: - Where in the srcBuf should the slicing process start, in sample. + Where in the srcBuf should the slicing process start, in samples. :control numFrames: @@ -38,7 +38,7 @@ :control features: - The index of the buffer where the onset features will be written to. + The buffer where the onset features will be written to. :control metric: @@ -90,7 +90,7 @@ :control hopSize: - The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/BufOnsetSlice.rst b/doc/BufOnsetSlice.rst index af905c1..e7bca01 100644 --- a/doc/BufOnsetSlice.rst +++ b/doc/BufOnsetSlice.rst @@ -18,11 +18,11 @@ :control source: - The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. + The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed. :control startFrame: - Where in the srcBuf should the slicing process start, in sample. + Where in the srcBuf should the slicing process start, in samples. :control numFrames: @@ -38,7 +38,7 @@ :control indices: - The index of the buffer where the indices (in sample) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis. + The buffer where the indices (in samples) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis. :control metric: @@ -98,7 +98,7 @@ :control hopSize: - The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/BufPitch.rst b/doc/BufPitch.rst index 376984e..679cc7a 100644 --- a/doc/BufPitch.rst +++ b/doc/BufPitch.rst @@ -23,7 +23,7 @@ :control source: - The index of the buffer to use as the source material to be pitch-tracked. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be pitch-tracked. The different channels of multichannel buffers will be processed sequentially. :control select: @@ -82,7 +82,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/BufSines.rst b/doc/BufSines.rst index efd0914..2077c53 100644 --- a/doc/BufSines.rst +++ b/doc/BufSines.rst @@ -20,11 +20,11 @@ :control source: - The index of the buffer to use as the source material to be decomposed through the sinusoidal modelling process. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be decomposed through the sinusoidal modelling process. The different channels of multichannel buffers will be processed sequentially. :control startFrame: - Where in the srcBuf should the process start, in sample. + Where in the srcBuf should the process start, in samples. :control numFrames: @@ -40,11 +40,11 @@ :control sines: - The index of the buffer where the extracted sinusoidal component will be reconstructed. + The buffer where the extracted sinusoidal component will be reconstructed. :control residual: - The index of the buffer where the residual of the sinusoidal component will be reconstructed. + The buffer where the residual of the sinusoidal component will be reconstructed. :control bandwidth: @@ -88,7 +88,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/BufSpectralShape.rst b/doc/BufSpectralShape.rst index b8fbf5c..453e2bd 100644 --- a/doc/BufSpectralShape.rst +++ b/doc/BufSpectralShape.rst @@ -28,11 +28,11 @@ :control source: - The index of the buffer to use as the source material to be described through the various descriptors. The different channels of multichannel buffers will be processed sequentially. + The buffer to use as the source material to be described through the various descriptors. The different channels of multichannel buffers will be processed sequentially. :control startFrame: - Where in the srcBuf should the process start, in sample. + Where in the srcBuf should the process start, in samples. :control numFrames: @@ -76,7 +76,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/BufTransientSlice.rst b/doc/BufTransientSlice.rst index e65afd5..7893e45 100644 --- a/doc/BufTransientSlice.rst +++ b/doc/BufTransientSlice.rst @@ -27,7 +27,7 @@ :control numFrames: - How many frames of ``source`` should be process. The default of -1 indicates to process through the end of the buffer. + How many frames of ``source`` should be processed. The default of -1 indicates to process through the end of the buffer. :control startChan: diff --git a/doc/BufTransients.rst b/doc/BufTransients.rst index 616c243..a813ee3 100644 --- a/doc/BufTransients.rst +++ b/doc/BufTransients.rst @@ -29,7 +29,7 @@ :control numFrames: - How many frames of ``source`` should be process. The default of -1 indicates to process through the end of the buffer. + How many frames of ``source`` should be processed. The default of -1 indicates to process through the end of the buffer. :control startChan: diff --git a/doc/Chroma.rst b/doc/Chroma.rst index fff1de1..2606e17 100644 --- a/doc/Chroma.rst +++ b/doc/Chroma.rst @@ -47,7 +47,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/HPSS.rst b/doc/HPSS.rst index 7fe5ab8..313a90d 100644 --- a/doc/HPSS.rst +++ b/doc/HPSS.rst @@ -66,7 +66,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/MFCC.rst b/doc/MFCC.rst index 8d4af55..b5d994e 100644 --- a/doc/MFCC.rst +++ b/doc/MFCC.rst @@ -60,7 +60,7 @@ :control hopSize: - The window hop size. As MFCC computation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As MFCC computation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/MelBands.rst b/doc/MelBands.rst index 9c40ba2..9fff600 100644 --- a/doc/MelBands.rst +++ b/doc/MelBands.rst @@ -49,7 +49,7 @@ :control hopSize: - The window hop size. As spectral description relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As spectral description relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/NMFFilter.rst b/doc/NMFFilter.rst index d45e7b5..55469bc 100644 --- a/doc/NMFFilter.rst +++ b/doc/NMFFilter.rst @@ -39,7 +39,7 @@ :control hopSize: - The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/NMFMatch.rst b/doc/NMFMatch.rst index 7c17d10..3b69ab4 100644 --- a/doc/NMFMatch.rst +++ b/doc/NMFMatch.rst @@ -39,7 +39,7 @@ :control hopSize: - The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As NMF relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/NoveltyFeature.rst b/doc/NoveltyFeature.rst index 338f780..ed36fc3 100644 --- a/doc/NoveltyFeature.rst +++ b/doc/NoveltyFeature.rst @@ -51,7 +51,7 @@ :control hopSize: - The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. + The window hop size. As novelty estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. :control fftSize: diff --git a/doc/NoveltySlice.rst b/doc/NoveltySlice.rst index ac0b7e1..c3213aa 100644 --- a/doc/NoveltySlice.rst +++ b/doc/NoveltySlice.rst @@ -9,10 +9,6 @@ The process will return an audio stream with single sample impulses at estimated starting points of the different slices. - .. only_in:: sc - - The argument for ``algorithm`` can be passed as an integer (see table below) which is modulatable, or as one of the following symbols: ``\spectrum``, ``\mfcc``, ``\chroma``, ``\pitch``, or ``\loudness``. - :output: An audio stream with impulses at detected transients. The latency between the input and the output is hopSize * (((kernelSize+1)/2).asInteger + ((filterSize + 1) / 2).asInteger + 1) samples at maximum. @@ -63,7 +59,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/OnsetFeature.rst b/doc/OnsetFeature.rst index 8ef373d..3961ac3 100644 --- a/doc/OnsetFeature.rst +++ b/doc/OnsetFeature.rst @@ -66,7 +66,7 @@ :control hopSize: - The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As spectral differencing relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/OnsetSlice.rst b/doc/OnsetSlice.rst index 96e9928..58b0a4d 100644 --- a/doc/OnsetSlice.rst +++ b/doc/OnsetSlice.rst @@ -79,7 +79,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/Pitch.rst b/doc/Pitch.rst index 877caeb..45b0166 100644 --- a/doc/Pitch.rst +++ b/doc/Pitch.rst @@ -62,7 +62,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/Sines.rst b/doc/Sines.rst index c3a1c45..3ada0b8 100644 --- a/doc/Sines.rst +++ b/doc/Sines.rst @@ -63,7 +63,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/SpectralShape.rst b/doc/SpectralShape.rst index 981f3b9..790aa43 100644 --- a/doc/SpectralShape.rst +++ b/doc/SpectralShape.rst @@ -57,7 +57,7 @@ :control hopSize: - The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). + The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2). :control fftSize: diff --git a/doc/UMAP.rst b/doc/UMAP.rst index d310fb9..50a5f18 100644 --- a/doc/UMAP.rst +++ b/doc/UMAP.rst @@ -21,7 +21,7 @@ :control numNeighbours: - The number of neighbours considered by the algorithm to balance local vs global structures to conserve. Low values will prioritise preserving local structure, high values will help preserve the global structure. + The number of neighbours considered by the algorithm to balance local vs global structures to conserve. Low values will prioritise preservation of the local structure while high values will prioritise preservation of the global structure. :control minDist: