Skip to content

Commit

Permalink
[Fix] Documentation guide link (#148)
Browse files Browse the repository at this point in the history
* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter

* [Fix] Fix Guide Links in RST (#147)

* typos in knnclassifier~

* fix guide link
  • Loading branch information
James Bradbury authored Jun 15, 2022
1 parent 39b1187 commit 2db4d73
Show file tree
Hide file tree
Showing 45 changed files with 45 additions and 45 deletions.
2 changes: 1 addition & 1 deletion doc/AmpFeature.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Realtime Amplitude Differential Feature
:species: transformer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: AmpGate, AmpSlice, OnsetFeature, NoveltyFeature
:description: Calculate the amplitude differential feature in realtime.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/AmpGate.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Gate Detection on a Signal
:species: slicer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufAmpGate, AmpSlice, OnsetSlice, NoveltySlice, TransientSlice
:description: Absolute amplitude threshold gate detector on a real-time signal

Expand Down
2 changes: 1 addition & 1 deletion doc/AmpSlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Amplitude-based Detrending Slicer
:species: slicer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufAmpSlice, AmpGate, OnsetSlice, NoveltySlice, TransientSlice
:description: This class implements an amplitude-based slicer, with various customisable options and conditions to detect relative amplitude changes as onsets.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufAmpFeature.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Amplitude Differential Feature
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufAmpSlice, BufNoveltyFeature, BufAmpFeature, BufOnsetFeature
:description: Calculate the amplitude differential feature used by :fluid-obj:`BufAmpSlice`.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufAmpGate.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Gate Detection on a Bfufer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: AmpGate, BufAmpSlice, BufOnsetSlice, BufNoveltySlice, BufTransientSlice
:description: Absolute amplitude threshold gate detector on audio in a buffer

Expand Down
2 changes: 1 addition & 1 deletion doc/BufAmpSlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Amplitude-based Detrending Slicer for Buffers
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: AmpSlice, BufAmpGate, BufOnsetSlice, BufNoveltySlice, BufTransientSlice
:description: This class implements an amplitude-based slicer,with various customisable options and conditions to detect relative amplitude changes as onsets.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufChroma.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A histogram of pitch classes on a Buffer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/FluidBufMFCC
:sc-related: Guides/FluidCorpusManipulation, Classes/FluidBufMFCC
:see-also: Chroma, BufPitch, BufLoudness, BufMFCC, BufSpectralShape, BufStats
:description: This class computes a histogram of the energy contained for each pitch class across the analysis frequency range.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufCompose.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer Compositing Utility
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/Buffer
:sc-related: Guides/FluidCorpusManipulation, Classes/Buffer
:see-also: BufSelect, BufSelectEvery
:description:
A utility for manipulating the contents of buffers.
Expand Down
2 changes: 1 addition & 1 deletion doc/BufHPSS.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Harmonic-Percussive Source Separation Using Median Filtering
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: HPSS, BufSines, BufTransients
:description: FluidBufHPSS performs Harmonic-Percussive Source Separation (HPSS) on the contents of a Buffer.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufLoudness.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A Loudness and True-Peak Descriptor on a Buffer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: Loudness, BufPitch, BufMelBands, BufMFCC, BufSpectralShape, BufStats
:description: 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.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufMFCC.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Mel-Frequency Cepstral Coefficients as Spectral Descriptors on a Buffer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Guides/FluidBufMultiThreading, Classes/FluidBufMelBands
:sc-related: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading, Classes/FluidBufMelBands
:see-also:
:description: A classic timbral spectral descriptor, the Mel-Frequency Cepstral Coefficients (MFCCs).
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufMelBands.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A Perceptually Spread Spectral Contour Descriptor on a Buffer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/FluidBufMFCC
:sc-related: Guides/FluidCorpusManipulation, Classes/FluidBufMFCC
:see-also: MelBands, BufPitch, BufLoudness, BufMFCC, BufSpectralShape, BufStats
:description: Magnitudes for a number of perceptually-evenly spaced bands.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufNMF.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Non-Negative Matrix Factorisation on Spectral Frames
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/FluidNMFMatch, Classes/FluidNMFFilter
:sc-related: Guides/FluidCorpusManipulation, Classes/FluidNMFMatch, Classes/FluidNMFFilter
:see-also: NMFMatch, NMFFilter
:description: Decomposes the spectrum of a sound into a number of components using Non-Negative Matrix Factorisation (NMF)
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufNoveltyFeature.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Novelty Feature
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufNoveltySlice, BufNoveltyFeature, BufAmpFeature, BufOnsetFeature
:description: Calculates the novelty feature of audio stored in a buffer.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufNoveltySlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Novelty-Based Slicer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: NoveltySlice, BufAmpSlice, BufOnsetSlice, BufTransientSlice
:description: A non-real-time slicer using an algorithm assessing novelty in the signal to estimate the slicing points.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufOnsetFeature.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Spectral Difference Feature
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufOnsetSlice, BufNoveltyFeature, BufAmpFeature, BufOnsetFeature
:description: Calculate the spectral difference feature used by :fluid-obj:`BufOnsetSlice`.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufOnsetSlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Spectral Difference-Based Audio Buffer Slicer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: OnsetSlice, BufAmpSlice, BufNoveltySlice, BufTransientSlice
:description: Implements a selection of spectrum-based onset slicers
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufPitch.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Pitch Descriptor
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
:sc-related: Guides/FluidCorpusManipulation, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
:see-also: Pitch, BufLoudness, BufMelBands, BufMFCC, BufSpectralShape, BufStats
:description: Three popular pitch descriptors, all of which compute frequency and the confidence that a pitch is present.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufScale.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A Scaling Processor for Buffers
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Guides/FluidBufMultiThreading
:sc-related: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading
:see-also: BufThresh, BufCompose, BufFlatten
:description: Scale |buffer| values from an input range to an output range.
:discussion: This object is for scaling |buffer| values. It copies data from a source |buffer| to a destination |buffer|, scaling the source from an input range to an output range.
Expand Down
2 changes: 1 addition & 1 deletion doc/BufSines.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Sinusoidal Modelling and Resynthesis
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: Sines, BufHPSS, BufTransients
:description: Sinusoidal modelling on buffers
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufSpectralShape.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Seven Spectral Shape Descriptors on a Buffer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
:sc-related: Guides/FluidCorpusManipulation, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
:see-also: SpectralShape, BufPitch, BufMelBands, BufMFCC, BufLoudness, BufStats
:description: Seven of the spectral shape descriptors, computed on a linear scale for both amplitude and frequency.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufStats.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Statistically summarise a time series in a Buffer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufLoudness, BufPitch, BufMelBands, BufMFCC, BufSpectralShape
:description: Statistical analysis on buffer channels.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufThreadDemo.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A Tutorial Object to Experiment with Multithreading in FluidBuf* Objects
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Guides/FluidBufMultiThreading
:sc-related: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading
:see-also:
:description:
This class implements a simple tutorial object to illustrate and experiment with the behaviour of the FluidBuf* objects. 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.
Expand Down
2 changes: 1 addition & 1 deletion doc/BufThresh.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A Gate Processor for Buffers
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Guides/FluidBufMultiThreading
:sc-related: Guides/FluidCorpusManipulation, Guides/FluidBufMultiThreading
:see-also: BufCompose, Gain, Stats
:description:

Expand Down
2 changes: 1 addition & 1 deletion doc/BufTransientSlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Transient-Based Slicer
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit,
:sc-related: Guides/FluidCorpusManipulation,
:see-also: TransientSlice, BufOnsetSlice, BufNoveltySlice
:description: Transient-based slice extractor on buffers
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/BufTransients.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Buffer-Based Transient Extractor
:species: buffer-proc
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: Transients, BufHPSS, BufSines
:description: Separate Transients from a Signal in a Buffer
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/Chroma.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A histogram of pitch classes in Real-Time
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/FluidMFCC
:sc-related: Guides/FluidCorpusManipulation, Classes/FluidMFCC
:see-also: BufChroma, Pitch, Loudness, MFCC, SpectralShape
:description: This class computes a histogram of the energy contained for each pitch class across the analysis frequency range.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/Gain.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Real-Time Buffered Gain Changer
:species: transformer
:sc-categories: UGens>Algebraic, Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit,Classes/UnaryOpFunction
:sc-related: Guides/FluidCorpusManipulation,Classes/UnaryOpFunction
:description: This class implements a sanity test for the FluCoMa Real-Time Client Wrapper.
:see-also:
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/HPSS.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Harmonic-Percussive Source Separation Using Median Filtering
:species: transformer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufHPSS, Sines, Transients
:description: Harmonic-Percussive Source Separation (HPSS) on an audio input.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/Loudness.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A Loudness and True-Peak Descriptor in Real-Time
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufLoudness, Pitch, MelBands, MFCC, SpectralShape
:description: Two loudness descriptors, with a ITU BS 1770 mode
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/MFCC.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Mel-Frequency Cepstral Coefficients as Spectral Descriptors in Real-Time
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufMFCC, Pitch, MelBands, Loudness, SpectralShape
:description: A classic timbral audio descriptor, the Mel-Frequency Cepstral Coefficients (MFCCs).
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/MelBands.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: A Perceptually Spread Spectral Contour Descriptor
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/FluidMFCC
:sc-related: Guides/FluidCorpusManipulation, Classes/FluidMFCC
:see-also: BufMelBands, Pitch, Loudness, MFCC, SpectralShape
:description: Magnitudes for a number of perceptually-evenly spaced bands.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/NMFFilter.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Real-Time Non-Negative Matrix Factorisation with Fixed Bases
:species: transformer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: NMFMatch, BufNMF
:description: Decomposes and resynthesises a signal against a set of spectral templates
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/NMFMatch.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Real-Time Non-Negative Matrix Factorisation with Fixed Bases
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: NMFFilter, BufNMF
:description: Matches an incoming audio signal against a set of spectral templates
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/NoveltyFeature.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Realtime Novelty Feature
:species: descriptor
:sc-categories: Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: NoveltySlice, AmpFeature, OnsetFeature
:description: Calculates the novelty feature of audio in realtime.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/NoveltySlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Real-Time Novelty-Based Slicer
:species: slicer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufNoveltySlice, OnsetSlice, AmpSlice, TransientSlice
:description: A real-time slicer using an algorithm assessing novelty in the signal to estimate the slicing points.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/OnsetFeature.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Realtime Spectral Difference Feature
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: OnsetSlice, NoveltyFeature, AmpFeature
:description: Calculate the spectral difference feature used by :fluid-obj:`OnsetSlice`.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/OnsetSlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Spectral Difference-Based Real-Time Audio Slicer
:species: slicer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufOnsetSlice, AmpSlice, NoveltySlice, TransientSlice
:description: Implements a selection of spectrum-based onset slicers
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/Pitch.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Real-time Pitch Descriptor
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/Pitch
:sc-related: Guides/FluidCorpusManipulation, Classes/Pitch
:see-also: BufPitch, MFCC, MelBands, Loudness, SpectralShape
:description: Three popular monophonic pitch descriptors, all of which compute frequency and confidence.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/STFTPass.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Real-Time FFT/IFFT return trip.
:species: transformer
:sc-categories: UGens>Algebraic, Libraries>FluidDecomposition, UGens>Buffer
:sc-related: Guides/FluidCorpusManipulationToolkit,Classes/UnaryOpFunction
:sc-related: Guides/FluidCorpusManipulation,Classes/UnaryOpFunction
:see-also:
:description: This class implements a sanity test for the FluCoMa Real-Time Client FFT/IFFT Wrapper.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/Sines.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Sinusoidal Modelling and Resynthesis
:species: transformer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufSines, Transients,HPSS
:description: Sinusoidal Modelling process on its audio input.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/SpectralShape.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Seven Spectral Shape Descriptors in Real-Time
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
:sc-related: Guides/FluidCorpusManipulation, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
:see-also: BufSpectralShape, Pitch, MelBands, Loudness, MFCC
:description: Seven of the spectral shape descriptors, computed on a linear scale for both amplitude and frequency.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/Stats.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Rolling mean and standard deviation on control inputs
:species: descriptor
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufStats, Standardize
:description: Computes the rolling mean and sample standard deviation over a given window for multichannel control inputs.
:discussion:
Expand Down
2 changes: 1 addition & 1 deletion doc/TransientSlice.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:digest: Transient-Based Real-Time Audio Slicer
:species: slicer
:sc-categories: Libraries>FluidDecomposition
:sc-related: Guides/FluidCorpusManipulationToolkit
:sc-related: Guides/FluidCorpusManipulation
:see-also: BufTransientSlice, AmpSlice, NoveltySlice, OnsetSlice
:description: A real-time transient-based slice extractor
:discussion:
Expand Down
Loading

0 comments on commit 2db4d73

Please sign in to comment.