From 0149e1f4d73eadd4d299c0aa9146bec56780e56f Mon Sep 17 00:00:00 2001 From: Owen Green Date: Sat, 29 May 2021 15:51:41 +0100 Subject: [PATCH] Add new overview help --- .../Guides/FluidCorpusManipulation.schelp | 118 ++++++++++++++++++ .../Guides/FluidDecomposition.schelp | 93 -------------- 2 files changed, 118 insertions(+), 93 deletions(-) create mode 100644 release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp delete mode 100644 release-packaging/HelpSource/Guides/FluidDecomposition.schelp diff --git a/release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp b/release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp new file mode 100644 index 0000000..33562a0 --- /dev/null +++ b/release-packaging/HelpSource/Guides/FluidCorpusManipulation.schelp @@ -0,0 +1,118 @@ +TITLE:: Fluid Corpus Manipulation Toolkit +SUMMARY:: An overview of the FluCoMa toolkit to analyse, transform and learn from sounds +CATEGORIES:: Libraries>FluidDecomposition, Guides>FluCoMa + +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. + +Almost all objects for audio analysis or transformation have audio-rate and buffer-based versions, and there are custom server-side containers for data analysis. footnote:: +This toolbox was made possible thanks to the link::http://www.flucoma.org/##FluCoMa project:: 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).:: + +section::Contents +list:: +##link::#Slice Audio:: +##link::#Analyse Audio:: +##link::#Decompose Audio:: +##link::#Transform Audio:: +##link::#Analyse Data:: +##link::#Helpers:: +:: +section::Slice Audio + +table:: +## strong::on signals:: || strong:: on buffers:: || strong::digest:: +## Link::Classes/FluidAmpGate:: || LINK:: Classes/FluidBufAmpGate:: || Events from amplitude enevelope +## LINK:: Classes/FluidAmpSlice:: || Link::Classes/FluidBufAmpSlice:: || Onsets from amplitude envelope +## link::Classes/FluidOnsetSlice::||link::Classes/FluidBufOnsetSlice::||Spectral onset detecor +## link::Classes/FluidTransientSlice::||link::Classes/FluidBufTransientSlice::||Transient model onset detector +## LINK:: Classes/FluidNoveltySlice::||LINK:: Classes/FluidBufNoveltySlice::|| Novelty based onset detection on a choice of descriptors +:: + +section:: Analyse Audio + +table:: +## strong::on signals:: || strong:: on buffers:: || strong::digest:: +##link::Classes/FluidPitch:: || link::Classes/FluidBufPitch:: || Choice of pitch descriptors +##link::Classes/FluidLoudness:: || link::Classes/FluidBufLoudness:: || Loudness Descriptor +##link::Classes/FluidMelBands:: || link::Classes/FluidBufMelBands:: || Energy in Mel Bands +##link::Classes/FluidMFCC:: || link::Classes/FluidBufMFCC:: || Timbral Descriptor with Mel Frequency Cepstral Coefficients +##link::Classes/FluidSpectralShape:: || link::Classes/FluidBufSpectralShape:: || Seven Spectral Shape Descriptors +##link::Classes/FluidChroma:: || link::Classes/FluidBufChroma:: || Pitch Classes Descriptor +##link::Classes/FluidNMFMatch:: || || Real-time activation of link::Classes/FluidBufNMF##NMF:: bases +## || link::Classes/FluidBufNNDSVD::|| Quick starting estimates for link::Classes/FluidBufNMF##NMF:: components using Singular Value Decomposition +:: + +section:: Decompose Audio +table:: +## strong::on signals:: || strong:: on buffers:: || strong::digest:: +##link::Classes/FluidSines:: || link::Classes/FluidBufSines:: || Decompose into sines + residual +##link::Classes/FluidTransients:: || link::Classes/FluidBufTransients:: ||Decompose into transients + residual +##link::Classes/FluidHPSS:: || link::Classes/FluidBufHPSS:: ||Decompose into 'harmonic' and 'percussive' layers +## || link::Classes/FluidBufNMF:: ||Use Nonnegative Matrix Factorisation to explore and decompose sounds +## || link::Classes/FluidBufSTFT:: || Perform STFT / ISTFT on link::Classes/Buffer::s +:: + +section::Transform Audio + +table:: +## strong::on signals:: || strong:: on buffers:: || strong::digest:: +##link::Classes/FluidAudioTransport:: || link::Classes/FluidBufAudioTransport:: || Interpolate between sounds using Optimal Transport +##link::Classes/FluidNMFFilter:: || ||Filter sound using link::Classes/FluidBufNMF##NMF:: bases +##link::Classes/FluidNMFMorph:: || ||Morph between sounds using link::Classes/FluidBufNMF##NMF:: components +## || link::Classes/FluidBufNMFCross::||Cross synthesise buffers using link::Classes/FluidBufNMF##NMF:: components +:: + +section:: Analyse Data + +subsection::Containers +table:: +##link::Classes/FluidDataSet:: || Container for labelled, multidimensional data +##link::Classes/FluidLabelSet:: || Container of labels associated with IDs +:: +subsection:: Buffer Analysis +table:: +##link::Classes/FluidBufStats:: || Compute statistics on link::Classes/Buffer::s +:: +subsection:: Preprocessing +table:: +##link::Classes/FluidNormalize:: || Normalize link::Classes/FluidDataSet::s and link::Classes/Buffer::s +##link::Classes/FluidStandardize:: || Standardize link::Classes/FluidDataSet::s and link::Classes/Buffer::s +##link::Classes/FluidRobustScale:: || Scale link::Classes/FluidDataSet::s and link::Classes/Buffer::s using order statistics +:: +subsection:: Searching and Querying +table:: +##link::Classes/FluidKDTree:: || Nearest Neighbour queries on link::Classes/FluidDataSet:: +##link::Classes/FluidDataSetQuery:: || Construct custom queries on link::Classes/FluidDataSet:: +:: +subsection::Supervised Machine Learning +table:: +##link::Classes/FluidKNNRegressor:: || Regression by Nearest Neighbour modelling +##link::Classes/FluidKNNClassifier:: || Classification by Nearest Neighbour modelling +##link::Classes/FluidMLPRegressor:: || Regression using Multilayer Perceptron model +##link::Classes/FluidMLPClassifier:: || Classification by Nearest Neighbour modelling +:: +subsection::Unsupervised Machine Learning +table:: +##link::Classes/FluidPCA:: || Principal Component Analysis for preprocessing and dimension reduction +##link::Classes/FluidMDS:: || Multidimensional Scaling for dimension reduction +##link::Classes/FluidKMeans:: || K-Means clustering +##link::Classes/FluidUMAP:: || Dimension reduction with UMAP algorithm +:: + +section:: Helpers + +subsection:: Buffer Utilities +table:: +##link::Classes/FluidBufCompose:: || Copy, slice, stack, mix concatenate. All the things you've wanted to do with buffers... +##link::Classes/FluidBufScale:: || Remap range of values (like linlin etc.) +##link::Classes/FluidBufThresh:: || Zero elements below threshold +##link::Classes/FluidBufSelect:: || Select range (frame-wise or channel wise) +##link::Classes/FluidBufSelectEvery:: || Select every N elements (frame-wise or channel wise) +##link::Classes/FluidBufFlatten:: || Flatten multichannel data into single channel 'point' +:: +subsection:: Corpus Building +table:: +##link::Classes/FluidLoadFolder:: || Load a folder of sounds into a link::Classes/Buffer:: +##link::Classes/FluidSliceCorpus:: || Batch-slice a corpus +##link::Classes/FluidProcessSlices:: || Batch-analyse slices +:: diff --git a/release-packaging/HelpSource/Guides/FluidDecomposition.schelp b/release-packaging/HelpSource/Guides/FluidDecomposition.schelp deleted file mode 100644 index 2f5f49d..0000000 --- a/release-packaging/HelpSource/Guides/FluidDecomposition.schelp +++ /dev/null @@ -1,93 +0,0 @@ -TITLE:: Fluid Decomposition Toolbox -SUMMARY:: An overview of the FluCoMa toolbox for signal decomposition -CATEGORIES:: Libraries>FluidDecomposition, Guides>FluCoMa - -DESCRIPTION:: -The Fluid Decomposition toolbox 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). Almost all objects have audio-rate and buffer-based versions. footnote:: -This toolbox was made possible thanks to the FluCoMa project ( http://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).:: - -subsection:: Slices -LINK:: Classes/FluidAmpSlice:: & -LINK:: Classes/FluidBufAmpSlice:: - -LINK:: Classes/FluidAmpGate:: & -LINK:: Classes/FluidBufAmpGate:: - -Slice by amplitude envelope - -LINK:: Classes/FluidOnsetSlice:: & -LINK:: Classes/FluidBufOnsetSlice:: - -Slice by onsets in the spectral domain - -LINK:: Classes/FluidNoveltySlice:: & -LINK:: Classes/FluidBufNoveltySlice:: - -Slice by estimated novelty on a choice of features - -LINK:: Classes/FluidTransientSlice:: & -LINK:: Classes/FluidBufTransientSlice:: - -Slice by transient modelling - -subsection:: Layers -LINK:: Classes/FluidSines:: & -LINK:: Classes/FluidBufSines:: - -Decompose into sines + residual - -LINK:: Classes/FluidTransients:: & -LINK:: Classes/FluidBufTransients:: - -Decompose into transients + residual - -LINK:: Classes/FluidHPSS:: & -LINK:: Classes/FluidBufHPSS:: - -Decompose into 'harmonic' and 'percussive' layers - -subsection:: Objects -LINK:: Classes/FluidBufNMF:: & -LINK:: Classes/FluidNMFFilter:: & -LINK:: Classes/FluidNMFMatch:: - -Use Nonnegative Matrix Factorisation to explore and decompose sounds - -subsection:: Descriptors -LINK:: Classes/FluidLoudness:: & -LINK:: Classes/FluidBufLoudness:: - -Report amplitude and peak, or r128 loudness and true peak - -LINK:: Classes/FluidPitch:: & -LINK:: Classes/FluidBufPitch:: - -A suite of pitch estimators - -LINK:: Classes/FluidMelBands:: & -LINK:: Classes/FluidBufMelBands:: - -Energy across Mel bands - -LINK:: Classes/FluidMFCC:: & -LINK:: Classes/FluidBufMFCC:: - -Mel Frequency Ceptstral Coefficients - -LINK:: Classes/FluidSpectralShape:: & -LINK:: Classes/FluidBufSpectralShape:: - -Summary measures of spectral shape - -LINK:: Classes/FluidBufStats:: - -Statistics of buffers - -subsection:: Utility -LINK:: Classes/FluidBufCompose:: - -Copy, slice, stack, mix concatenate. All the things you've wanted to do with buffers... - -LINK:: Classes/FluidBufThreadDemo:: - -A tutorial object to experiment with multithreading in FluidBuf* objects