diff --git a/release-packaging/HelpSource/Classes/FluidAmpGate.schelp b/release-packaging/HelpSource/Classes/FluidAmpGate.schelp index 2f61f63..ffd2124 100644 --- a/release-packaging/HelpSource/Classes/FluidAmpGate.schelp +++ b/release-packaging/HelpSource/Classes/FluidAmpGate.schelp @@ -1,10 +1,10 @@ TITLE:: FluidAmpGate SUMMARY:: Amplitude-based Gating Slicer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class implements an amplitude-based slicer, with various customisable options and conditions to detect absolute amplitude changes as onsets and offsets. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements an amplitude-based slicer, with various customisable options and conditions to detect absolute amplitude changes as onsets and offsets. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ FluidAmpSlice is based on an envelop follower on a highpassed version of the signal, which is then going through a Schmidt trigger and state-aware time contraints. The example code below is unfolding the various possibilites in order of complexity. diff --git a/release-packaging/HelpSource/Classes/FluidAmpSlice.schelp b/release-packaging/HelpSource/Classes/FluidAmpSlice.schelp index e22dac7..a1ccee1 100644 --- a/release-packaging/HelpSource/Classes/FluidAmpSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidAmpSlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidAmpSlice SUMMARY:: Amplitude-based Detrending Slicer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class implements an amplitude-based slicer, with various customisable options and conditions to detect relative amplitude changes as onsets. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements an amplitude-based slicer, with various customisable options and conditions to detect relative amplitude changes as onsets. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ FluidAmpSlice is based on two envelop followers on a highpassed version of the signal: one slow that gives the trend, and one fast. Each have features that will interact. The example code below is unfolding the various possibilites in order of complexity. diff --git a/release-packaging/HelpSource/Classes/FluidAudioTransport.schelp b/release-packaging/HelpSource/Classes/FluidAudioTransport.schelp index aa8a147..32032bb 100644 --- a/release-packaging/HelpSource/Classes/FluidAudioTransport.schelp +++ b/release-packaging/HelpSource/Classes/FluidAudioTransport.schelp @@ -1,6 +1,6 @@ TITLE:: FluidAudioTransport summary:: Interpolate between sounds -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidBufAudioTransport DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufAmpGate.schelp b/release-packaging/HelpSource/Classes/FluidBufAmpGate.schelp index c654ee6..1e5db75 100644 --- a/release-packaging/HelpSource/Classes/FluidBufAmpGate.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufAmpGate.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufAmpGate SUMMARY:: Amplitude-based Gating Slicer for Buffers -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements an amplitude-based slicer, with various customisable options and conditions to detect absolute amplitude changes as onsets and offsets. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements an amplitude-based slicer, with various customisable options and conditions to detect absolute amplitude changes as onsets and offsets. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ FluidBufAmpGate is based on an envelop follower on a highpassed version of the signal, which is then going through a Schmidt trigger and state-aware time contraints. The example code below is unfolding the various possibilites in order of complexity. diff --git a/release-packaging/HelpSource/Classes/FluidBufAmpSlice.schelp b/release-packaging/HelpSource/Classes/FluidBufAmpSlice.schelp index 0dcca74..12cb53c 100644 --- a/release-packaging/HelpSource/Classes/FluidBufAmpSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufAmpSlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufAmpSlice SUMMARY:: Amplitude-based Detrending Slicer for Buffers -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements an amplitude-based slicer,with various customisable options and conditions to detect relative amplitude changes as onsets. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements an amplitude-based slicer,with various customisable options and conditions to detect relative amplitude changes as onsets. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ FluidBufAmpSlice is based on two envelop followers on a highpassed version of the signal: one slow that gives the trend, and one fast. Each have features that will interact. The example code below is unfolding the various possibilites in order of complexity. diff --git a/release-packaging/HelpSource/Classes/FluidBufAudioTransport.schelp b/release-packaging/HelpSource/Classes/FluidBufAudioTransport.schelp index 102e6ee..4edaf95 100644 --- a/release-packaging/HelpSource/Classes/FluidBufAudioTransport.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufAudioTransport.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBufAudioTransport summary:: Interpolate between buffers -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidAudioTransport DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufChroma.schelp b/release-packaging/HelpSource/Classes/FluidBufChroma.schelp index 03f3e7f..6a44422 100644 --- a/release-packaging/HelpSource/Classes/FluidBufChroma.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufChroma.schelp @@ -1,7 +1,7 @@ TITLE:: FluidBufChroma SUMMARY:: An histogram of pitch classes on a Buffer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidChroma +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/FluidChroma DESCRIPTION:: This class computes a histogram of the energy contained for each pitch class across the analysis frequency range. Also known as a chromagram, this typically allows you to get a contour of how much each semitone is represented in the spectrum over time. The number of bands (and, thus, pitch classes) and the central reference frequency can be adjusted. diff --git a/release-packaging/HelpSource/Classes/FluidBufCompose.schelp b/release-packaging/HelpSource/Classes/FluidBufCompose.schelp index d9c2f2c..8ce52a6 100644 --- a/release-packaging/HelpSource/Classes/FluidBufCompose.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufCompose.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufCompose SUMMARY:: Buffer Compositing Utility -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/Buffer +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/Buffer DESCRIPTION:: -A FluidBufCompose object provides a flexible utility for combining the contents of buffers on the server. It can be used for thing like mixing down multichannel buffers, or converting from left-right stereo to mid-side. It is used extensively in all the example code of LINK::Guides/FluidDecomposition:: as part of the FluCoMa project. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +A FluidBufCompose object provides a flexible utility for combining the contents of buffers on the server. It can be used for thing like mixing down multichannel buffers, or converting from left-right stereo to mid-side. It is used extensively in all the example code of LINK::Guides/FluidCorpusManipulation:: as part of the FluCoMa project. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ At its most simple, the object copies the content of a source buffer into a destination buffer. The flexibility comes from the various flags controlling which portions and channels of the source to use, and by applying gains (which can be positive or negative) to the source data and the portion of the destination that would be overwritten. diff --git a/release-packaging/HelpSource/Classes/FluidBufFlatten.schelp b/release-packaging/HelpSource/Classes/FluidBufFlatten.schelp index dbe1c2b..8b8fd25 100644 --- a/release-packaging/HelpSource/Classes/FluidBufFlatten.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufFlatten.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBufFlatten summary:: Flatten a multichannel buffer on the server -categories:: FluidCorpusManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/Buffer, Classes/FluidBufCompose, Classes/FluidBufSelect, Classes/FluidBufSelectEvery DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp b/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp index c2b361c..63c821d 100644 --- a/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp @@ -1,7 +1,7 @@ TITLE:: FluidBufHPSS SUMMARY:: Buffer-Based Harmonic-Percussive Source Separation Using Median Filtering -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: @@ -16,7 +16,7 @@ The algorithm takes a buffer in, and divides it into two or three outputs, depen ## a percussive component; ## a residual of the previous two if the flag is set to inter-dependant thresholds. See the maskingMode below.:: -It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ STRONG::Threading:: diff --git a/release-packaging/HelpSource/Classes/FluidBufLoudness.schelp b/release-packaging/HelpSource/Classes/FluidBufLoudness.schelp index 86651fd..6b2a6ed 100644 --- a/release-packaging/HelpSource/Classes/FluidBufLoudness.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufLoudness.schelp @@ -1,11 +1,11 @@ TITLE:: FluidBufLoudness SUMMARY:: A Loudness and True-Peak Descriptor on a Buffer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements two loudness descriptors, computing the true peak of the signal as well as applying the filters proposed by broadcasting standards to emulate the perception of amplitude. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements two loudness descriptors, computing the true peak of the signal as well as applying the filters proposed by broadcasting standards to emulate the perception of amplitude. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a multichannel buffer with two channels per input channel, one for loudness and one for the true peak value of the frame, both in dBfs. More information on broadcasting standardisation of loudness measurement is available at the reference page FOOTNOTE::https://tech.ebu.ch/docs/tech/tech3341.pdf:: and in more musician-friendly explantions here FOOTNOTE::http://designingsound.org/2013/02/06/loudness-and-metering-part-1/::. Each sample represents a value, which is every hopSize. Its sampling rate is STRONG::sourceSR / hopSize::. diff --git a/release-packaging/HelpSource/Classes/FluidBufMFCC.schelp b/release-packaging/HelpSource/Classes/FluidBufMFCC.schelp index 2dda1fb..7c8c6ce 100644 --- a/release-packaging/HelpSource/Classes/FluidBufMFCC.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufMFCC.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufMFCC SUMMARY:: Mel-Frequency Cepstral Coefficients as Spectral Descriptors on a Buffer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidBufMelBands +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/FluidBufMelBands DESCRIPTION:: -This class implements a classic spectral descriptor, the Mel-Frequency Cepstral Coefficients (https://en.wikipedia.org/wiki/Mel-frequency_cepstrum). The input is first filtered in to STRONG::numBands:: perceptually-spaced bands, as in LINK::Classes/FluidMelBands::. It is then analysed into STRONG::numCoeffs:: number of cepstral coefficients. It has the advantage of being amplitude invariant, except for the first coefficient. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a classic spectral descriptor, the Mel-Frequency Cepstral Coefficients (https://en.wikipedia.org/wiki/Mel-frequency_cepstrum). The input is first filtered in to STRONG::numBands:: perceptually-spaced bands, as in LINK::Classes/FluidMelBands::. It is then analysed into STRONG::numCoeffs:: number of cepstral coefficients. It has the advantage of being amplitude invariant, except for the first coefficient. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a single multichannel buffer of STRONG::numCoeffs:: per input channel. Each frame represents a value, which is every hopSize. diff --git a/release-packaging/HelpSource/Classes/FluidBufMelBands.schelp b/release-packaging/HelpSource/Classes/FluidBufMelBands.schelp index 199cee6..358237d 100644 --- a/release-packaging/HelpSource/Classes/FluidBufMelBands.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufMelBands.schelp @@ -1,11 +1,11 @@ TITLE:: FluidBufMelBands SUMMARY:: A Perceptually Spread Spectral Contour Descriptor on a Buffer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidBufMFCC +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/FluidBufMFCC DESCRIPTION:: -This class implements a spectral shape descriptor where the amplitude is given for a number of equally spread perceptual bands. The spread is based on the Mel scale (https://en.wikipedia.org/wiki/Mel_scale) which is one of the first attempt to mimic pitch perception scientifically. This implementation allows to select the range and number of bands dynamically. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a spectral shape descriptor where the amplitude is given for a number of equally spread perceptual bands. The spread is based on the Mel scale (https://en.wikipedia.org/wiki/Mel_scale) which is one of the first attempt to mimic pitch perception scientifically. This implementation allows to select the range and number of bands dynamically. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a single multichannel buffer of STRONG::numBands:: per input channel. Each frame represents a value, which is every hopSize. diff --git a/release-packaging/HelpSource/Classes/FluidBufNMF.schelp b/release-packaging/HelpSource/Classes/FluidBufNMF.schelp index cb00040..656f59c 100644 --- a/release-packaging/HelpSource/Classes/FluidBufNMF.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufNMF.schelp @@ -1,7 +1,7 @@ TITLE:: FluidBufNMF SUMMARY:: Buffer-Based Non-Negative Matrix Factorisation on Spectral Frames -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidNMFMatch, Classes/FluidNMFFilter +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/FluidNMFMatch, Classes/FluidNMFFilter DESCRIPTION:: The FluidBufNMF object decomposes the spectrum of a sound into a number of components using Non-Negative Matrix Factorisation (NMF) footnote:: Lee, Daniel D., and H. Sebastian Seung. 1999. ‘Learning the Parts of Objects by Non-Negative Matrix Factorization’. Nature 401 (6755): 788–91. https://doi.org/10.1038/44565. @@ -27,7 +27,7 @@ In this implementation, the components are reconstructed by masking the original The whole process can be related to a channel vocoder where, instead of fixed bandpass filters, we get more complex filter shapes that are learned from the data, and the activations correspond to channel envelopes. -FluidBufNMF is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +FluidBufNMF is part of the LINK::Guides/FluidCorpusManipulation::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ STRONG::Threading:: diff --git a/release-packaging/HelpSource/Classes/FluidBufNMFCross.schelp b/release-packaging/HelpSource/Classes/FluidBufNMFCross.schelp index acc8a06..673f4ec 100644 --- a/release-packaging/HelpSource/Classes/FluidBufNMFCross.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufNMFCross.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBufNMFCross summary:: Reconstructs the sound in the target buffer using components learned from the source buffer using an NMF decomposition -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidBufNMF, Classes/FluidNMFMatch, Classes/FluidNMFFilter DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp b/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp index 822e4a2..9ab1598 100644 --- a/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBufNNDSVD summary:: Non-Negative Double Singular Value Decomposition on a Buffer -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidBufNMF DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp b/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp index dbbf115..e4f9890 100644 --- a/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufNoveltySlice SUMMARY:: Buffer-Based Novelty-Based Slicer -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements a non-real-time slicer using an algorithm assessing novelty in the signal to estimate the slicing points. A novelty curve is being derived from running a kernel across the diagonal of the similarity matrix, and looking for peak of changes. It implements the seminal results published in 'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a non-real-time slicer using an algorithm assessing novelty in the signal to estimate the slicing points. A novelty curve is being derived from running a kernel across the diagonal of the similarity matrix, and looking for peak of changes. It implements the seminal results published in 'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a buffer which contains indices (in sample) of estimated starting points of different slices. diff --git a/release-packaging/HelpSource/Classes/FluidBufOnsetSlice.schelp b/release-packaging/HelpSource/Classes/FluidBufOnsetSlice.schelp index e3228f8..80e6ee5 100644 --- a/release-packaging/HelpSource/Classes/FluidBufOnsetSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufOnsetSlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufOnsetSlice SUMMARY:: Spectral Difference-Based Audio Buffer Slicer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements many spectral-based onset detection metrics, most of them taken from the literature. (http://www.dafx.ca/proceedings/papers/p_133.pdf) Some are already available in SuperCollider's LINK::Classes/Onsets:: object yet not as offline processes. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements many spectral-based onset detection metrics, most of them taken from the literature. (http://www.dafx.ca/proceedings/papers/p_133.pdf) Some are already available in SuperCollider's LINK::Classes/Onsets:: object yet not as offline processes. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a buffer which contains indices (in sample) of estimated starting points of different slices. diff --git a/release-packaging/HelpSource/Classes/FluidBufPitch.schelp b/release-packaging/HelpSource/Classes/FluidBufPitch.schelp index ad939f6..ec70fc5 100644 --- a/release-packaging/HelpSource/Classes/FluidBufPitch.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufPitch.schelp @@ -1,11 +1,11 @@ TITLE:: FluidBufPitch SUMMARY:: A Selection of Pitch Descriptors on a Buffer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile DESCRIPTION:: -This class implements three popular pitch descriptors, computed as frequency and the confidence in its value. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements three popular pitch descriptors, computed as frequency and the confidence in its value. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a multichannel buffer with two channels per input channel, one for pitch and one for the pitch tracking confidence. A pitch of 0 is yield when the algorithm cannot find a fundamental at all. Each sample represents a value, which is every hopSize. Its sampling rate is sourceSR / hopSize. diff --git a/release-packaging/HelpSource/Classes/FluidBufSTFT.schelp b/release-packaging/HelpSource/Classes/FluidBufSTFT.schelp index 86815f3..a2755eb 100644 --- a/release-packaging/HelpSource/Classes/FluidBufSTFT.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufSTFT.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBufSTFT summary:: Perform a Short-Time Fourier Transform on one channel of a buffer -categories:: FluidCorpusManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/Buffer DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufScale.schelp b/release-packaging/HelpSource/Classes/FluidBufScale.schelp index cecfc24..d511920 100644 --- a/release-packaging/HelpSource/Classes/FluidBufScale.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufScale.schelp @@ -1,9 +1,9 @@ TITLE:: FluidBufScale SUMMARY:: A Scaling Processor for Buffers -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading -This class implements a simple Buffer preprocessor, by scaling its values. It draws a simple translation from inputLow to outputLow, and from inputHigh to outputHigh. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a simple Buffer preprocessor, by scaling its values. It draws a simple translation from inputLow to outputLow, and from inputHigh to outputHigh. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a buffer with the same size and shape than the requested range. diff --git a/release-packaging/HelpSource/Classes/FluidBufSelect.schelp b/release-packaging/HelpSource/Classes/FluidBufSelect.schelp index e20a544..55b2520 100644 --- a/release-packaging/HelpSource/Classes/FluidBufSelect.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufSelect.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBufSelect summary:: Cherry pick values from a buffer -categories:: FluidCorpusManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidBufSelectEvery DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufSelectEvery.schelp b/release-packaging/HelpSource/Classes/FluidBufSelectEvery.schelp index cb83c0e..2b33a7e 100644 --- a/release-packaging/HelpSource/Classes/FluidBufSelectEvery.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufSelectEvery.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBufSelectEvery summary:: Extract every N samples / channels from a buffer -categories:: FluidCorpusManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidBufSelect DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidBufSines.schelp b/release-packaging/HelpSource/Classes/FluidBufSines.schelp index 35d07f1..fa52319 100644 --- a/release-packaging/HelpSource/Classes/FluidBufSines.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufSines.schelp @@ -1,11 +1,11 @@ TITLE:: FluidBufSines SUMMARY:: Buffer-Based Sinusoidal Modelling and Resynthesis -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Guides/FluidBufMultiThreading DESCRIPTION:: -This class triggers a Sinusoidal Modelling process on buffers on the non-real-time thread of the server. It implements a mix of algorithms taken from classic papers. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class triggers a Sinusoidal Modelling process on buffers on the non-real-time thread of the server. It implements a mix of algorithms taken from classic papers. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The algorithm will take a buffer in, and will divide it in two parts: LIST:: ## a reconstruction of what it detects as sinusoidal; diff --git a/release-packaging/HelpSource/Classes/FluidBufSpectralShape.schelp b/release-packaging/HelpSource/Classes/FluidBufSpectralShape.schelp index 4a33ec2..3e3365a 100644 --- a/release-packaging/HelpSource/Classes/FluidBufSpectralShape.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufSpectralShape.schelp @@ -1,11 +1,11 @@ TITLE:: FluidBufSpectralShape SUMMARY:: Seven Spectral Shape Descriptors on a Buffer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidSpectralShape, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/FluidSpectralShape, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile DESCRIPTION:: -This class implements seven of the most popular spectral shape descriptors, computed on a linear scale for both amplitude and frequency. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements seven of the most popular spectral shape descriptors, computed on a linear scale for both amplitude and frequency. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The descriptors are: LIST:: diff --git a/release-packaging/HelpSource/Classes/FluidBufStats.schelp b/release-packaging/HelpSource/Classes/FluidBufStats.schelp index 39aae16..77cad30 100644 --- a/release-packaging/HelpSource/Classes/FluidBufStats.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufStats.schelp @@ -1,11 +1,11 @@ TITLE:: FluidBufStats SUMMARY:: Computing Statistics on Buffers as Series. -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements non-real-time statistical analysis on buffer channels. Typically, a buffer would hold various time series (i.e. descriptors over time), and link::Classes/FluidBufStats:: allows this series to be described statistically. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements non-real-time statistical analysis on buffer channels. Typically, a buffer would hold various time series (i.e. descriptors over time), and link::Classes/FluidBufStats:: allows this series to be described statistically. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process returns a buffer where each channel of the STRONG::source:: buffer has been reduced to 7 statistics: mean, standard deviation, skewness, kurtosis, followed by 3 percentiles, by default the minimum value, the median, and the maximum value. Moreover, it is possible to request the same 7 stats to be applied to derivative of the input. These are useful to describe statistically the rate of change of the time series. The STRONG::stats:: buffer will grow accordingly, yielding the seven same statistical description of the n requested derivatives. Therefore, the STRONG::stats:: buffer will have as many channel as the input buffer, and as many frames as 7 times the requested STRONG::numDerivs::. diff --git a/release-packaging/HelpSource/Classes/FluidBufThreadDemo.schelp b/release-packaging/HelpSource/Classes/FluidBufThreadDemo.schelp index 24a89ff..22667a4 100644 --- a/release-packaging/HelpSource/Classes/FluidBufThreadDemo.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufThreadDemo.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufThreadDemo SUMMARY:: A Tutorial Object to Experiment with Multithreading in FluidBuf* Objects -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements a simple tutorial object to illustrate and experiment with the behaviour of the FluidBuf* objects. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a simple tutorial object to illustrate and experiment with the behaviour of the FluidBuf* objects. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ It simply starts a process that will, upon completion of its task, write a single value to the destination buffer. This is the general behaviour of much of the CPU consuming FluidBuf* objects. In this case, as a toy example, the task is simply just wait and do nothing, to simulate a task that would actually take that long in the background. diff --git a/release-packaging/HelpSource/Classes/FluidBufThresh.schelp b/release-packaging/HelpSource/Classes/FluidBufThresh.schelp index f905faa..6c9b057 100644 --- a/release-packaging/HelpSource/Classes/FluidBufThresh.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufThresh.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufThresh SUMMARY:: A Gate Processor for Buffers -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class implements a simple Buffer preprocessor, by replacing values under a threshold by 0s. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a simple Buffer preprocessor, by replacing values under a threshold by 0s. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a buffer with the same size and shape than the requested range. diff --git a/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp b/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp index 71926c3..4ba0760 100644 --- a/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufTransientSlice SUMMARY:: Buffer-Based Transient-Based Slicer -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidBufTransients +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/FluidBufTransients DESCRIPTION:: -This class implements a non-real-time transient-based slice extractor relying on the same algorithm than Classes/FluidBufTransients using clicks/transients/derivation/anomaly in the signal to estimate the slicing points. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a non-real-time transient-based slice extractor relying on the same algorithm than Classes/FluidBufTransients using clicks/transients/derivation/anomaly in the signal to estimate the slicing points. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a buffer which contains indices (in sample) of estimated starting points of the different slices. diff --git a/release-packaging/HelpSource/Classes/FluidBufTransients.schelp b/release-packaging/HelpSource/Classes/FluidBufTransients.schelp index fc427a0..5b3e2fa 100644 --- a/release-packaging/HelpSource/Classes/FluidBufTransients.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufTransients.schelp @@ -1,10 +1,10 @@ TITLE:: FluidBufTransients SUMMARY:: Buffer-Based Transient Extractor -CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading +CATEGORIES:: Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading DESCRIPTION:: -This class triggers a transient extractor on buffers on the non-real-time thread of the server. It implements declicking algorithm from chapter 5 of the classic Digital Audio Restoration by Godsill, Simon J., Rayner, Peter J.W. with some bespoke improvements on the detection function tracking. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class triggers a transient extractor on buffers on the non-real-time thread of the server. It implements declicking algorithm from chapter 5 of the classic Digital Audio Restoration by Godsill, Simon J., Rayner, Peter J.W. with some bespoke improvements on the detection function tracking. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The algorithm will take a buffer in, and will divide it in two outputs: LIST:: ## the transients, estimated from the signal and extracted from it; diff --git a/release-packaging/HelpSource/Classes/FluidChroma.schelp b/release-packaging/HelpSource/Classes/FluidChroma.schelp index 74bd08f..1f3dc46 100644 --- a/release-packaging/HelpSource/Classes/FluidChroma.schelp +++ b/release-packaging/HelpSource/Classes/FluidChroma.schelp @@ -1,12 +1,12 @@ TITLE:: FluidChroma SUMMARY:: An histogram of pitch classes in Real-Time -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidBufChroma +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Classes/FluidBufChroma DESCRIPTION:: This class computes a histogram of the energy contained for each pitch class across the analysis frequency range. Also known as a chromagram, this typically allows you to get a contour of how much each semitone is represented in the spectrum over time. The number of bands (and, thus, pitch classes) and the central reference frequency can be adjusted. -It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a multichannel control steam of size STRONG::maxNumChroma::, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period. diff --git a/release-packaging/HelpSource/Classes/FluidDataSet.schelp b/release-packaging/HelpSource/Classes/FluidDataSet.schelp index 6643181..fa83eb9 100644 --- a/release-packaging/HelpSource/Classes/FluidDataSet.schelp +++ b/release-packaging/HelpSource/Classes/FluidDataSet.schelp @@ -1,10 +1,10 @@ TITLE:: FluidDataSet summary:: Container for labelled, multidimensional data -categories:: UGens>FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKMeans ​ DESCRIPTION:: -A server-side container associating labels with multi-dimensional data. FluidDataSet is identified by its name. +A server-side container associating labels with multi-dimensional data. CLASSMETHODS:: ​ diff --git a/release-packaging/HelpSource/Classes/FluidDataSetQuery.schelp b/release-packaging/HelpSource/Classes/FluidDataSetQuery.schelp index e41bc26..6648207 100644 --- a/release-packaging/HelpSource/Classes/FluidDataSetQuery.schelp +++ b/release-packaging/HelpSource/Classes/FluidDataSetQuery.schelp @@ -1,6 +1,6 @@ TITLE:: FluidDataSetQuery summary:: Query a FluidDataSet -categories:: UGens>FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidDataSet DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidDataSetWr.schelp b/release-packaging/HelpSource/Classes/FluidDataSetWr.schelp index f92de08..25f5615 100644 --- a/release-packaging/HelpSource/Classes/FluidDataSetWr.schelp +++ b/release-packaging/HelpSource/Classes/FluidDataSetWr.schelp @@ -1,6 +1,6 @@ TITLE:: FluidDataSetWr summary:: Write to FluidDataSet on the server -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FLuidDataSet DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidGain.schelp b/release-packaging/HelpSource/Classes/FluidGain.schelp index 0933940..e013166 100644 --- a/release-packaging/HelpSource/Classes/FluidGain.schelp +++ b/release-packaging/HelpSource/Classes/FluidGain.schelp @@ -1,11 +1,11 @@ TITLE:: FluidGain SUMMARY:: Real-Time Buffered Gain Changer -CATEGORIES:: UGens>Algebraic, Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition,Classes/UnaryOpFunction +CATEGORIES:: UGens>Algebraic, Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation,Classes/UnaryOpFunction DESCRIPTION:: -This class implements a sanity test for the FluCoMa Real-Time Client Wrapper. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a sanity test for the FluCoMa Real-Time Client Wrapper. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ CLASSMETHODS:: diff --git a/release-packaging/HelpSource/Classes/FluidHPSS.schelp b/release-packaging/HelpSource/Classes/FluidHPSS.schelp index 96f2570..57cee38 100644 --- a/release-packaging/HelpSource/Classes/FluidHPSS.schelp +++ b/release-packaging/HelpSource/Classes/FluidHPSS.schelp @@ -1,7 +1,7 @@ TITLE:: FluidHPSS SUMMARY:: Harmonic-Percussive Source Separation Using Median Filtering -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation A FluidHPSS object performs Harmonic-Percussive Source Separation (HPSS) on the an audio input. The class performs HPSS as described in its original form footnote:: Fitzgerald, Derry. 2010. ‘Harmonic/Percussive Separation Using Median Filtering’. In Proceedings DaFx 10. https://arrow.dit.ie/argcon/67. @@ -14,7 +14,7 @@ The algorithm takes an audio in, and divides it into two or three outputs, depen ## a percussive component; ## a residual of the previous two if the flag is set to inter-dependant thresholds. See the maskingMode below.:: -It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ CLASSMETHODS:: diff --git a/release-packaging/HelpSource/Classes/FluidKDTree.schelp b/release-packaging/HelpSource/Classes/FluidKDTree.schelp index 14100e6..ae60eb8 100644 --- a/release-packaging/HelpSource/Classes/FluidKDTree.schelp +++ b/release-packaging/HelpSource/Classes/FluidKDTree.schelp @@ -1,6 +1,6 @@ TITLE:: FluidKDTree summary:: KD Tree on the server -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidDataSet DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidKMeans.schelp b/release-packaging/HelpSource/Classes/FluidKMeans.schelp index 1dcf71f..97db48a 100644 --- a/release-packaging/HelpSource/Classes/FluidKMeans.schelp +++ b/release-packaging/HelpSource/Classes/FluidKMeans.schelp @@ -1,6 +1,6 @@ TITLE:: FluidKMeans summary:: Cluster data points with K-Means -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidDataSet, Classes/FluidLabelSet, Classes/FluidKNNClassifier, Classes/FluidKNNRegressor DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidLabelSet.schelp b/release-packaging/HelpSource/Classes/FluidLabelSet.schelp index 91ee776..858a2ae 100644 --- a/release-packaging/HelpSource/Classes/FluidLabelSet.schelp +++ b/release-packaging/HelpSource/Classes/FluidLabelSet.schelp @@ -1,6 +1,6 @@ TITLE:: FluidLabelSet summary:: A set of labels associated with IDs -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidDataSet, Classes/FluidKMeans DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidLoadFolder.schelp b/release-packaging/HelpSource/Classes/FluidLoadFolder.schelp index 1697203..98555cc 100644 --- a/release-packaging/HelpSource/Classes/FluidLoadFolder.schelp +++ b/release-packaging/HelpSource/Classes/FluidLoadFolder.schelp @@ -1,6 +1,6 @@ TITLE:: FluidLoadFolder summary:: Load a folder of audio into a single buffer -categories:: FluidCorpusManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidSliceCorpus, Classes/FluidProcessSlices DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidLoudness.schelp b/release-packaging/HelpSource/Classes/FluidLoudness.schelp index 769b236..5450e93 100644 --- a/release-packaging/HelpSource/Classes/FluidLoudness.schelp +++ b/release-packaging/HelpSource/Classes/FluidLoudness.schelp @@ -1,10 +1,10 @@ TITLE:: FluidLoudness SUMMARY:: A Loudness and True-Peak Descriptor in Real-Time -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class implements two loudness descriptors, computing the true peak of the signal as well as applying the filters proposed by broadcasting standards to emulate the perception of amplitude. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements two loudness descriptors, computing the true peak of the signal as well as applying the filters proposed by broadcasting standards to emulate the perception of amplitude. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a multichannel control steam with [loudness, truepeak] values, both in dBfs, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period. More information on broadcasting standardisation of loudness measurement is available at the reference page FOOTNOTE::https://tech.ebu.ch/docs/tech/tech3341.pdf:: and in more musician-friendly explantions here FOOTNOTE::http://designingsound.org/2013/02/06/loudness-and-metering-part-1/::. diff --git a/release-packaging/HelpSource/Classes/FluidMFCC.schelp b/release-packaging/HelpSource/Classes/FluidMFCC.schelp index dac7a3f..5922100 100644 --- a/release-packaging/HelpSource/Classes/FluidMFCC.schelp +++ b/release-packaging/HelpSource/Classes/FluidMFCC.schelp @@ -1,10 +1,10 @@ TITLE:: FluidMFCC SUMMARY:: Mel-Frequency Cepstral Coefficients as Spectral Descriptors in Real-Time -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidMelBands +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Classes/FluidMelBands DESCRIPTION:: -This class implements a classic spectral descriptor, the Mel-Frequency Cepstral Coefficients (https://en.wikipedia.org/wiki/Mel-frequency_cepstrum). The input is first filtered in to STRONG::numBands:: perceptually-spaced bands, as in LINK::Classes/FluidMelBands::. It is then analysed into STRONG::numCoeffs:: number of cepstral coefficients. It has the avantage of being amplitude invarient, except for the first coefficient. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a classic spectral descriptor, the Mel-Frequency Cepstral Coefficients (https://en.wikipedia.org/wiki/Mel-frequency_cepstrum). The input is first filtered in to STRONG::numBands:: perceptually-spaced bands, as in LINK::Classes/FluidMelBands::. It is then analysed into STRONG::numCoeffs:: number of cepstral coefficients. It has the avantage of being amplitude invarient, except for the first coefficient. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a multichannel control steam of STRONG::maxNumCoeffs::, which will be repeated if no change happens within the algorythm, i.e. when the hopSize is larger than the server's kr period. diff --git a/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp b/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp index 5bb3dca..67f4cca 100644 --- a/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp +++ b/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp @@ -1,9 +1,9 @@ -TITLE:: FluidManipulationClient -summary:: A base case for FluidManipulation classes -categories:: FluidManipulation +TITLE:: Libraries>FluidCorpusManipulationClient +summary:: A base case for Libraries>FluidCorpusManipulation classes +categories:: Libraries>FluidCorpusManipulation DESCRIPTION:: -A utility base class for FluidManipulation classes, that deals with common functionality (wrapping a link::Classes/Synth:: in the instance, etc.) +A utility base class for Libraries>FluidCorpusManipulation classes, that deals with common functionality (wrapping a link::Classes/Synth:: in the instance, etc.) Not intended to be used directly. diff --git a/release-packaging/HelpSource/Classes/FluidMelBands.schelp b/release-packaging/HelpSource/Classes/FluidMelBands.schelp index 7cdb0fd..235df85 100644 --- a/release-packaging/HelpSource/Classes/FluidMelBands.schelp +++ b/release-packaging/HelpSource/Classes/FluidMelBands.schelp @@ -1,10 +1,10 @@ TITLE:: FluidMelBands SUMMARY:: A Perceptually Spread Spectral Contour Descriptor in Real-Time -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidMFCC +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Classes/FluidMFCC DESCRIPTION:: -This class implements a spectral shape descriptor where the amplitude is given for a number of equally spread perceptual bands. The spread is based on the Mel scale (https://en.wikipedia.org/wiki/Mel_scale) which is one of the first attempt to mimic pitch perception scientifically. This implementation allows to select the range and number of bands dynamically. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a spectral shape descriptor where the amplitude is given for a number of equally spread perceptual bands. The spread is based on the Mel scale (https://en.wikipedia.org/wiki/Mel_scale) which is one of the first attempt to mimic pitch perception scientifically. This implementation allows to select the range and number of bands dynamically. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a multichannel control steam of size STRONG::maxNumBands::, which will be repeated if no change happens within the algorythm, i.e. when the hopSize is larger than the server's kr period. diff --git a/release-packaging/HelpSource/Classes/FluidNMFFilter.schelp b/release-packaging/HelpSource/Classes/FluidNMFFilter.schelp index db9c268..003d273 100644 --- a/release-packaging/HelpSource/Classes/FluidNMFFilter.schelp +++ b/release-packaging/HelpSource/Classes/FluidNMFFilter.schelp @@ -1,7 +1,7 @@ TITLE:: FluidNMFFilter SUMMARY:: Real-Time Non-Negative Matrix Factorisation with Fixed Bases -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidBufNMF, Classes/FluidNMFMatch +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Classes/FluidBufNMF, Classes/FluidNMFMatch DESCRIPTION:: The FluidNMFFilter object decomposes and resynthesises an incoming audio signal against a set of spectral templates using an slimmed-down version of Nonnegative Matrix Factorisation (NMF) footnote:: Lee, Daniel D., and H. Sebastian Seung. 1999. ‘Learning the Parts of Objects by Non-Negative Matrix Factorization’. Nature 401 (6755): 788–91. https://doi.org/10.1038/44565. :: @@ -12,7 +12,7 @@ NMF has been a popular technique in signal processing research for things like s The whole process can be related to a channel vocoder where, instead of fixed bandpass filters, we get more complex filter shapes and the activations correspond to channel envelopes. -FluidBufNMF is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +FluidNMFFilter is part of the LINK:: Guides/FluidCorpusManipulation::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ CLASSMETHODS:: diff --git a/release-packaging/HelpSource/Classes/FluidNMFMatch.schelp b/release-packaging/HelpSource/Classes/FluidNMFMatch.schelp index a98d2bd..36eb58f 100644 --- a/release-packaging/HelpSource/Classes/FluidNMFMatch.schelp +++ b/release-packaging/HelpSource/Classes/FluidNMFMatch.schelp @@ -1,7 +1,7 @@ TITLE:: FluidNMFMatch SUMMARY:: Real-Time Non-Negative Matrix Factorisation with Fixed Bases -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidBufNMF, Classes/FluidNMFFilter +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Classes/FluidBufNMF, Classes/FluidNMFFilter DESCRIPTION:: The FluidNMFMatch object matches an incoming audio signal against a set of spectral templates using an slimmed-down version of Nonnegative Matrix Factorisation (NMF) footnote:: Lee, Daniel D., and H. Sebastian Seung. 1999. ‘Learning the Parts of Objects by Non-Negative Matrix Factorization’. Nature 401 (6755): 788–91. https://doi.org/10.1038/44565. :: @@ -12,7 +12,7 @@ NMF has been a popular technique in signal processing research for things like s The whole process can be related to a channel vocoder where, instead of fixed bandpass filters, we get more complex filter shapes and the activations correspond to channel envelopes. -FluidBufNMF is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +FluidNMFMatch is part of the LINK:: Guides/FluidCorpusManipulation::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ CLASSMETHODS:: diff --git a/release-packaging/HelpSource/Classes/FluidNMFMorph.schelp b/release-packaging/HelpSource/Classes/FluidNMFMorph.schelp index c594fd3..cd9b27c 100644 --- a/release-packaging/HelpSource/Classes/FluidNMFMorph.schelp +++ b/release-packaging/HelpSource/Classes/FluidNMFMorph.schelp @@ -1,6 +1,6 @@ TITLE:: FluidNMFMorph summary:: Morph between sounds -categories:: FluidCorpusManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidAudioTransport,Classes/FluidBufNMFCross diff --git a/release-packaging/HelpSource/Classes/FluidNormalize.schelp b/release-packaging/HelpSource/Classes/FluidNormalize.schelp index 5718cd6..3a52331 100644 --- a/release-packaging/HelpSource/Classes/FluidNormalize.schelp +++ b/release-packaging/HelpSource/Classes/FluidNormalize.schelp @@ -1,6 +1,6 @@ TITLE:: FluidNormalize summary:: Normalize a FluidDataSet -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidStandardize, Classes/FluidRobustScale, Classes/FluidDataSet DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidNoveltySlice.schelp b/release-packaging/HelpSource/Classes/FluidNoveltySlice.schelp index 89edceb..367dca8 100644 --- a/release-packaging/HelpSource/Classes/FluidNoveltySlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidNoveltySlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidNoveltySlice SUMMARY:: Real-Time Novelty-Based Slicer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class implements a real-time slicer using an algorithm assessing novelty in the signal to estimate the slicing points. A novelty curve is being derived from running a kernel across the diagonal of the similarity matrix, and looking for peak of changes. It implements the seminal results published in 'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a real-time slicer using an algorithm assessing novelty in the signal to estimate the slicing points. A novelty curve is being derived from running a kernel across the diagonal of the similarity matrix, and looking for peak of changes. It implements the seminal results published in 'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return an audio steam with sample-long impulses at estimated starting points of the different slices. diff --git a/release-packaging/HelpSource/Classes/FluidOnsetSlice.schelp b/release-packaging/HelpSource/Classes/FluidOnsetSlice.schelp index dcc14ce..80bbef3 100644 --- a/release-packaging/HelpSource/Classes/FluidOnsetSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidOnsetSlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidOnsetSlice SUMMARY:: Spectral Difference-Based Real-Time Audio Slicer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class implements many spectral based onset detection metrics, most of them taken from the literature. (http://www.dafx.ca/proceedings/papers/p_133.pdf) Some are already available in SuperCollider's LINK::Classes/Onsets:: object. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements many spectral based onset detection metrics, most of them taken from the literature. (http://www.dafx.ca/proceedings/papers/p_133.pdf) Some are already available in SuperCollider's LINK::Classes/Onsets:: object. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return an audio steam with sample-long impulses at estimated starting points of the different slices. diff --git a/release-packaging/HelpSource/Classes/FluidPitch.schelp b/release-packaging/HelpSource/Classes/FluidPitch.schelp index 6f5a46f..a4cd43b 100644 --- a/release-packaging/HelpSource/Classes/FluidPitch.schelp +++ b/release-packaging/HelpSource/Classes/FluidPitch.schelp @@ -1,10 +1,10 @@ TITLE:: FluidPitch SUMMARY:: A Selection of Pitch Descriptors in Real-Time -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/Pitch +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Classes/Pitch DESCRIPTION:: -This class implements three popular pitch descriptors, computed as frequency and the confidence in its value. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements three popular pitch descriptors, computed as frequency and the confidence in its value. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return a multichannel control steam with [pitch, confidence] values, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period. A pitch of 0 is yield when the algorithm cannot find a fundamental at all. diff --git a/release-packaging/HelpSource/Classes/FluidProcessSlices.schelp b/release-packaging/HelpSource/Classes/FluidProcessSlices.schelp index 5de64ec..a3cb8dc 100644 --- a/release-packaging/HelpSource/Classes/FluidProcessSlices.schelp +++ b/release-packaging/HelpSource/Classes/FluidProcessSlices.schelp @@ -1,7 +1,7 @@ TITLE:: FluidProcessSlices summary:: Utility for batch processing slices -categories:: FluidManipulation -related:: Classes/FluidLoadFolder, Classes/FluidSliceCorpus,Guides/FluidDecomposition +categories:: Libraries>FluidCorpusManipulation +related:: Classes/FluidLoadFolder, Classes/FluidSliceCorpus,Guides/FluidCorpusManipulation DESCRIPTION:: This class abstracts some of the boilerplate involved in batch processing a sequence of segments in a link::Classes/Buffer:: on the server. It does this by iteratively running a user supplied function and using slice point information passed as an link::Classes/IdentityDictionary:: (see link::Classes/FluidLoadFolder#-index:: for details on the format of this). diff --git a/release-packaging/HelpSource/Classes/FluidRobustScale.schelp b/release-packaging/HelpSource/Classes/FluidRobustScale.schelp index 5237e55..d9b7175 100644 --- a/release-packaging/HelpSource/Classes/FluidRobustScale.schelp +++ b/release-packaging/HelpSource/Classes/FluidRobustScale.schelp @@ -1,6 +1,6 @@ TITLE:: FluidRobustScale summary:: Apply Robust Scaling to FluidDataSet -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidStandardize, Classes/FluidNormalize, Classes/FluidDataSet DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp b/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp index 90f2c59..d834c36 100644 --- a/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp +++ b/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp @@ -1,11 +1,11 @@ TITLE:: FluidSTFTPass SUMMARY:: Real-Time FFT/IFFT return trip. -CATEGORIES:: UGens>Algebraic, Libraries>FluidDecomposition, UGens>Buffer -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition,Classes/UnaryOpFunction +CATEGORIES:: UGens>Algebraic, Libraries>FluidCorpusManipulation, UGens>Buffer +RELATED:: Guides/FluidCorpusManipulation,Classes/UnaryOpFunction DESCRIPTION:: -This class implements a sanity test for the FluCoMa Real-Time Client FFT/IFFT Wrapper. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a sanity test for the FluCoMa Real-Time Client FFT/IFFT Wrapper. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ CLASSMETHODS:: diff --git a/release-packaging/HelpSource/Classes/FluidSines.schelp b/release-packaging/HelpSource/Classes/FluidSines.schelp index c34d207..1d75f92 100644 --- a/release-packaging/HelpSource/Classes/FluidSines.schelp +++ b/release-packaging/HelpSource/Classes/FluidSines.schelp @@ -1,10 +1,10 @@ TITLE:: FluidSines SUMMARY:: Sinusoidal Modelling and Resynthesis -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class applies a Sinusoidal Modelling process on its audio input. It implements a mix of algorithms taken from classic papers. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class applies a Sinusoidal Modelling process on its audio input. It implements a mix of algorithms taken from classic papers. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The algorithm will take an audio in, and will divide it in two parts: LIST:: ## a reconstruction of what it detects as sinusoidal; diff --git a/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp b/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp index 2abeec4..b99ffd2 100644 --- a/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp +++ b/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp @@ -1,6 +1,6 @@ TITLE:: FluidSliceCorpus summary:: A utility for batch slicing of a corpus -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidLoadFolder, Classes/FluidProcessSlices, Classes/FluidBufOnsetSlice, Classes/FluidBufNoveltySlice, Classes/FluidBufTransientSlice DESCRIPTION:: @@ -29,7 +29,7 @@ definitionlist:: || The destination link::Classes/Buffer:: into which to write slice indices :: -This configuration assumes that you are using one of the link::Guides/FluidDecomposition:: buffer-based slicing objects, or at least following their conventions, notably: +This configuration assumes that you are using one of the link::Guides/FluidCorpusManipulation:: buffer-based slicing objects, or at least following their conventions, notably: list:: ## slice points are written into a buffer as sample positions. ## If no slices are found, then a single value of -1 is written instead diff --git a/release-packaging/HelpSource/Classes/FluidSpectralShape.schelp b/release-packaging/HelpSource/Classes/FluidSpectralShape.schelp index a149500..b8db6e7 100644 --- a/release-packaging/HelpSource/Classes/FluidSpectralShape.schelp +++ b/release-packaging/HelpSource/Classes/FluidSpectralShape.schelp @@ -1,10 +1,10 @@ TITLE:: FluidSpectralShape SUMMARY:: Seven Spectral Shape Descriptors in Real-Time -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile DESCRIPTION:: -This class implements seven of the most popular spectral shape descriptors, computed on a linear scale for both amplitude and frequency. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements seven of the most popular spectral shape descriptors, computed on a linear scale for both amplitude and frequency. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The descriptors are: LIST:: @@ -322,4 +322,4 @@ b = Buffer.read(s,File.realpath(FluidSpectralShape.class.filenameSymbol).dirname ] }.scope; ) -:: \ No newline at end of file +:: diff --git a/release-packaging/HelpSource/Classes/FluidStandardize.schelp b/release-packaging/HelpSource/Classes/FluidStandardize.schelp index a10ceab..bd551c7 100644 --- a/release-packaging/HelpSource/Classes/FluidStandardize.schelp +++ b/release-packaging/HelpSource/Classes/FluidStandardize.schelp @@ -1,6 +1,6 @@ TITLE:: FluidStandardize summary:: Standardize a FluidDataSet -categories:: FluidManipulation +categories:: Libraries>FluidCorpusManipulation related:: Classes/FluidDataSet, Classes/FluidNormalize, Classes/FluidRobustScale DESCRIPTION:: diff --git a/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp b/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp index 55dc5dd..fa7b756 100644 --- a/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp @@ -1,10 +1,10 @@ TITLE:: FluidTransientSlice SUMMARY:: Transient-Based Real-Time Audio Slicer -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class implements a real-time transient-based slice extractor relying on the same algorithm than Classes/FluidBufTransients using clicks/transients/derivation/anomaly in the signal to estimate the slicing points. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class implements a real-time transient-based slice extractor relying on the same algorithm than Classes/FluidBufTransients using clicks/transients/derivation/anomaly in the signal to estimate the slicing points. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The process will return an audio steam with sample-long impulses at estimated starting points of the different slices. diff --git a/release-packaging/HelpSource/Classes/FluidTransients.schelp b/release-packaging/HelpSource/Classes/FluidTransients.schelp index 1fdafbc..b0659ce 100644 --- a/release-packaging/HelpSource/Classes/FluidTransients.schelp +++ b/release-packaging/HelpSource/Classes/FluidTransients.schelp @@ -1,10 +1,10 @@ TITLE:: FluidTransients SUMMARY:: Real-Time Transient Modeller and Extractor -CATEGORIES:: Libraries>FluidDecomposition -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: -This class applies a real-time transient extractor on its input. It implements declicking algorithm from chapter 5 of the classic Digital Audio Restoration by Godsill, Simon J., Rayner, Peter J.W. with some bespoke improvements on the detection function tracking. It is part of the LINK:: Guides/FluidDecomposition:: of LINK:: Guides/FluCoMa::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ +This class applies a real-time transient extractor on its input. It implements declicking algorithm from chapter 5 of the classic Digital Audio Restoration by Godsill, Simon J., Rayner, Peter J.W. with some bespoke improvements on the detection function tracking. It is part of the LINK:: Guides/FluidCorpusManipulation##Fluid Corpus Manipulation Toolkit::. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/ The algorithm will take an audio in, and will divide it in two outputs: LIST:: ## the transients, estimated from the signal and extracted from it; diff --git a/release-packaging/HelpSource/Guides/FluCoMa.schelp b/release-packaging/HelpSource/Guides/FluCoMa.schelp deleted file mode 100644 index bd55234..0000000 --- a/release-packaging/HelpSource/Guides/FluCoMa.schelp +++ /dev/null @@ -1,11 +0,0 @@ -title:: The Fluid Corpus Manipulation Project -summary:: This section gives an overview of the Fluid Corpus Manipulation Project -categories:: Libraries>FluidDecomposition -related:: Classes/FluidBufNMF, Guides/FluidDecomposition - -description:: -The Fluid Corpus Manipulation project (FluCoMA) instigates new musical ways of exploiting ever-growing banks of sound and gestures within the digital composition process, by bringing breakthroughs of signal decomposition DSP and machine learning to the toolset of techno-fluent computer composers, creative coders and digital artists. The first set of tools released is the LINK:: Guides/FluidDecomposition:: - -This was made possible thanks to a grant by the European Research Council ( https://erc.europa.eu/ ) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899). - -For more information, including a forum and learning material, please visit the FluCoMa project website at http://www.flucoma.org/ diff --git a/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp b/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp index 5b8aee9..622bb8c 100644 --- a/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp +++ b/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp @@ -1,7 +1,7 @@ TITLE:: FluidBuf* Multithreading Behaviour SUMMARY:: A tutorial on the multithreading behaviour of offline processes of the Fluid Decomposition toolbox for signal decomposition -CATEGORIES:: Libraries>FluidDecomposition, Guides>FluCoMa -RELATED:: Guides/FluCoMa, Guides/FluidDecomposition +CATEGORIES:: Libraries>FluidCorpusManipulation +RELATED:: Guides/FluidCorpusManipulation DESCRIPTION:: The Fluid Decomposition toolbox footnote::This toolbox was made possible thanks to the FluCoMa project, https://www.flucoma.org, funded by the European Research Council ( https://erc.europa.eu ) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899):: provides an open-ended, loosely coupled set of objects to break up and analyse sound in terms of slices (segments in time), layers (superpositions in time and frequency) and objects (configurable or discoverable patterns in sound). Many objects have audio-rate and buffer-based versions. diff --git a/release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp b/release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp index 33562a0..a3efb47 100644 --- a/release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp +++ b/release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp @@ -1,6 +1,6 @@ TITLE:: Fluid Corpus Manipulation Toolkit -SUMMARY:: An overview of the FluCoMa toolkit to analyse, transform and learn from sounds -CATEGORIES:: Libraries>FluidDecomposition, Guides>FluCoMa +SUMMARY:: The FluCoMa toolkit to analyse, transform and learn from sounds +CATEGORIES:: Libraries>FluidCorpusManipulation DESCRIPTION:: The Fluid Corpus Manipulation toolkit provides an open-ended, loosely coupled set of objects for exploring and music making with collections of sound. It includes tools for slicing, analysing, decomposition and transforming audio, as well as a suite of objects for exploring and organisng using machine learning. diff --git a/release-packaging/HelpSource/Guides/FluidDataTools.schelp b/release-packaging/HelpSource/Guides/FluidDataTools.schelp deleted file mode 100644 index 672d922..0000000 --- a/release-packaging/HelpSource/Guides/FluidDataTools.schelp +++ /dev/null @@ -1,67 +0,0 @@ -title:: The Fluid Corpus Manipulation Data Tools -summary:: Tools for organising, exploring and querying corpora -categories:: Libraries>FluidDecomposition,Guides>FluCoMa -related:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidDataSet,Classes/FluidLabelSet - -The suite of Fluid Corpus Manipulation data tools offer facilities for building, exploring, transforming and playing with corpora. The tools are built around two container classes, link::Classes/FluidDataSet:: and link::Classes/FluidLabelSet::, which provides a way to build up and stored collections of labelled data, and a suite of objects that act on these containers. - -The design and interface of many of these objects is heavily based on the Python library link::https://scikit-learn.org/stable/##scikit-learn::, a mature and well developed machine learning toolkit that is comparatively quick to get going with. As our documentation continues to develop, we will also lean quite heavily on sci-learn's! - -section:: Containers - -Map id labels to data points, or to other labels - -link::Classes/FluidDataSet:: - -link::Classes/FluidLabelSet:: - - -section:: DataSet Filtering - -Select and filter items from FluidDataSet by building queries - -link::Classes/FluidDataSetQuery:: - -section:: Data Structure - -Perform nearest neighbour searches - -link::Classes/FluidKDTree:: - -section:: Data Conditioning - -Pre-process data - -link::Classes/FluidNormalize:: - -link::Classes/FluidStandardize:: - -link::Classes/FluidRobustScale:: - -section:: Dimension Reduction - -Compress data to fewer dimensions for visualisation / efficiency / preprocessing - -link::Classes/FluidPCA:: - -link::Classes/FluidMDS:: - -section:: Supervised Learning - -Train supervised learning models using either K nearest neighbours or a simple neural network - -subsection:: Classification - -Map input data points to categories - -link::Classes/FluidKNNClassifier:: - -link::Classes/FluidMLPClassifier:: - -subsection:: Regression - -Map input data points to continuous output - -link::Classes/FluidKNNRegressor:: - -link::Classes/FluidMLPRegressor::