Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix] Documentation guide link #148

Merged
merged 124 commits into from
Jun 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
124 commits
Select commit Hold shift + click to select a range
0243518
mfcc rst and sc help file
tedmoore Feb 18, 2022
1b414bd
mfcc sc examples
tedmoore Feb 18, 2022
efe961f
mfcc output
tedmoore Feb 18, 2022
ee7d5ea
mfcc helpfile readability
tedmoore Feb 18, 2022
1663edd
BufMFCC udpates
tedmoore Feb 18, 2022
2bdf212
update bufonsetslice docs slightly (#87)
Feb 21, 2022
1105e14
fix audio transport segmentation of discussion and desc
Feb 21, 2022
b225dd4
fix audio transport segmentation of discussion and desc (#88)
Feb 21, 2022
d309905
add missing see alsos
Feb 21, 2022
5c2ed33
Merge branch 'docs/bufaudiotransport' into HEAD
Feb 21, 2022
2b27710
optional args: add to C++ wrapper
weefuzzy Feb 24, 2022
7c03d31
ParamDump and python: add choices param type
weefuzzy Feb 25, 2022
4f866de
Json driver (#35)
weefuzzy Feb 28, 2022
7b50523
Update json_api.yml
Feb 28, 2022
6e127c4
Update json_api.yml
Feb 28, 2022
be47611
Update json_api.yml
Feb 28, 2022
757c18b
change name of raw output to api.json
Feb 28, 2022
ffb22ce
Update json_api.yml
Feb 28, 2022
090e7e7
remove indentation on api
Feb 28, 2022
2661adf
typo in UMAP
Feb 28, 2022
d10b4fd
[Docs] OnsetSlice and BufOnsetSlice (#91)
Mar 2, 2022
092ad3f
revamp MelBands and BufMelBands RST, update SC example code
tedmoore Mar 2, 2022
f1d8a82
*melbands description
tedmoore Mar 2, 2022
83c4f65
added a hyphen
tedmoore Mar 2, 2022
a07bee3
pitch and buf pitch RST
tedmoore Mar 3, 2022
68dbdcb
added link to the learn page
tedmoore Mar 3, 2022
b7b7a29
edited normalize description
tedmoore Mar 3, 2022
45b00fd
Merge pull request #92 from flucoma/MelBands-reference
tedmoore Mar 3, 2022
0478be0
pitch sc help files
tedmoore Mar 3, 2022
370be76
BufFlatten RST and SC examples
tedmoore Mar 4, 2022
735cca6
buf thresh
tedmoore Mar 11, 2022
dda150c
sc help file
tedmoore Mar 21, 2022
ca395fb
typo in fluid pitch sc example code
tedmoore Mar 21, 2022
eb23f48
bufthresh rst
tedmoore Mar 21, 2022
d8a96ae
typo
tedmoore Mar 21, 2022
ba3c160
james' feedback
tedmoore Mar 22, 2022
9e29a7c
add .ds_store to gitignore
tremblap Mar 23, 2022
53835d6
Merge pull request #96 from flucoma/BufThresh
tedmoore Mar 24, 2022
88314a3
pa feedback
tedmoore Mar 24, 2022
894bbe6
pa feedback
tedmoore Mar 24, 2022
a6dd05b
Merge pull request #93 from flucoma/pitch
tedmoore Mar 24, 2022
5e23c97
pa feedback
tedmoore Mar 24, 2022
20d88b2
Merge pull request #94 from flucoma/BufFlatten
tedmoore Mar 24, 2022
5eaa22f
PA feedback
tedmoore Mar 24, 2022
ed93c51
Merge pull request #83 from flucoma/MFCC-helpfile-&-sc-example
tedmoore Mar 24, 2022
ccf1939
[Docs] Update Normalize Docs (#76)
Mar 24, 2022
56ad95e
[Docs] Slicer Feature Objects (#101)
Mar 29, 2022
315a61e
Merge branch 'main' into dev
tedmoore Mar 30, 2022
cc12351
changing preset and interface for noveltyslice examples
tremblap Apr 14, 2022
5cd4d72
Merge branch 'dev' of https://github.com/flucoma/flucoma-docs into dev
tremblap Apr 14, 2022
1bbf3c6
Add argument handlers for const DataSet / LabelSet
weefuzzy Apr 14, 2022
04541a6
Max/PD: Generate docs for control-in objects (input size and autosize)
weefuzzy May 2, 2022
65fda83
Merge branch 'dev' into enhance/optional-message-args
weefuzzy May 3, 2022
4e07e57
Merge pull request #89 from weefuzzy/enhance/optional-message-args
weefuzzy May 3, 2022
1b95f6d
Merge branch 'dev' into enhance/choices-param
weefuzzy May 3, 2022
3f45b91
Merge pull request #90 from weefuzzy/enhance/choices-param
weefuzzy May 3, 2022
fb437ad
Enhance/max params (#104)
weefuzzy May 3, 2022
64ca992
Add a `striprst` jinja filter for removing rst markup in templates (#…
weefuzzy May 5, 2022
e57d2fc
UMAP cmake reference to python sorted
tremblap May 5, 2022
a7237b6
Merge branch 'dev' of https://github.com/flucoma/flucoma-docs into dev
tremblap May 5, 2022
2768f74
typo
tedmoore May 5, 2022
a374e49
Wrapper and doc-gen update for new `maxFFTSize`
weefuzzy May 10, 2022
be8c30c
Buf stats (#103)
tedmoore May 10, 2022
6d4b89d
bufcompose update (#95)
May 11, 2022
5b0025e
PCA inverseTransformPoint (#97)
tedmoore May 11, 2022
b039b56
normalize the desc/disc of mfcc entries (#113)
May 23, 2022
1993e87
HPSS Help file (RST) and SC examples (#81)
tedmoore May 25, 2022
3291b01
Enhance/generate stubs (#119)
weefuzzy May 26, 2022
863c917
CI: Debug CMAKE_MODULE_PATH
weefuzzy May 26, 2022
576f6d5
CMake: Try setting module path using explicit source dir for core
weefuzzy May 26, 2022
43998eb
CI Debug: Print core/scripts
weefuzzy May 26, 2022
67301dd
CMake: Correct typo
weefuzzy May 26, 2022
b059120
CMake: MSVC with bigobj, tidy up messages
weefuzzy May 26, 2022
a1be779
set explicit UTF8 encoding when opening text
weefuzzy May 26, 2022
81db8fd
explicitly use utf8 for writing as well as reading
weefuzzy May 26, 2022
531b4c2
MDS RST & SC example code (#121)
tedmoore May 26, 2022
e409a4d
MLPRegressor & MLPClassifier RSTs & SC example Code (#109)
tedmoore May 26, 2022
bb02817
Standardize RST & SC examples (#117)
tedmoore May 26, 2022
9b8ce92
RobustScale (#118)
tedmoore May 26, 2022
d0849dd
KNNClassifier RST and SC example code (#127)
tedmoore May 31, 2022
b9d5a47
Stats RST & SC examples (#124)
tedmoore May 31, 2022
11342d2
PCA RST and SC Examples (#116)
tedmoore May 31, 2022
8439734
Update Standardize.rst
weefuzzy Jun 1, 2022
000f49c
maxFFTSize in SC driver is conditional on buffer-proc species (#129)
tedmoore Jun 1, 2022
488a4b0
BufSTFT RST and SC example code (#112)
tedmoore Jun 1, 2022
e729aa0
[Enhance] Learn platform link generation (#120)
Jun 1, 2022
86f62e4
typo
tedmoore Jun 3, 2022
bd1cc8c
bufnmf: adding resynthmode
tremblap Jun 4, 2022
1469303
resynthMode : camel case
tremblap Jun 4, 2022
8b71aa4
Change size to history (#133)
Jun 5, 2022
d0a99ec
BufNMFCross RST & SC example (#137)
tedmoore Jun 8, 2022
0873a27
NNDSVD (#138)
tedmoore Jun 8, 2022
465fbd2
NMFMorph (& species transformer[0]) (#135)
tedmoore Jun 8, 2022
b55a9ec
put bar chart back in (#123)
tedmoore Jun 8, 2022
0ed7eff
KNNRegressor (#136)
tedmoore Jun 8, 2022
fbe9725
(Buf)Transients(Slice) Family (#140)
tedmoore Jun 10, 2022
c6d002e
typos in rst
tremblap Jun 12, 2022
ceb65f0
typos in knnclassifier~ (#142)
Jun 13, 2022
dc6110a
sc example code for BufNMF now includes resynthMode
tedmoore Jun 13, 2022
5a54545
deleted SC Guid YAML file
tedmoore Jun 13, 2022
3c744bc
put spaces around hyperlinks
tedmoore Jun 13, 2022
bd1c1ca
BufTransients SC example (Waveform only 2 sec.)
tedmoore Jun 13, 2022
a144aa4
BufNNDSVD -> BufNMFSeed (#141)
tremblap Jun 13, 2022
32ca4e0
fix Loudness select in MLPRegressor example code
tedmoore Jun 13, 2022
c93cf97
fix bad link in nmf morph (BufNMFCross was missing the buf part)
tedmoore Jun 13, 2022
0676237
added inverse transform and inverse transform point to Normalize
tedmoore Jun 13, 2022
f93eaea
better code for testing all flucoma objects help files
tedmoore Jun 13, 2022
6668584
added argument k to KDTree RST
tedmoore Jun 13, 2022
1c6c046
fixed a bad link in KNNClassifier RST
tedmoore Jun 13, 2022
5ec761c
removed action arguments from RobustScale RST
tedmoore Jun 13, 2022
9db5839
fixed mistakes in RobustScale RST that was causing it to not render p…
tedmoore Jun 13, 2022
b2842a8
added select argument to BufLoudness and Loudness RST (the rest comin…
tedmoore Jun 13, 2022
83715d7
added pca whitening to PCA RST
tedmoore Jun 13, 2022
90b2e5c
adding select argument to appropriate RST files
tedmoore Jun 13, 2022
42d2d94
added radius argument to KDTree RST
tedmoore Jun 13, 2022
61642fb
added channels argument to BufSelect RST
tedmoore Jun 13, 2022
fda570b
checked example code files that use 'select' for possible errors
tedmoore Jun 13, 2022
031ccfe
found a bit more code needing resynthMode
tedmoore Jun 13, 2022
6996726
[Enhance] Interp to Interplation in NMFMorph (#143)
Jun 14, 2022
3476f8b
SKMeans (#132)
tremblap Jun 14, 2022
9410f1b
(Buf)AmpGate RST & SC examples (#122)
tedmoore Jun 14, 2022
fdc506d
added BufAmpGate maxSize parameter
tedmoore Jun 14, 2022
005f1ef
[Fix] Fix Guide Links in RST (#147)
Jun 15, 2022
8fde3f4
Merge branch 'main' into dev
Jun 15, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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