info on passing symbols for algorithm and metric to slicers

doc/BufNoveltyFeature.rst

@@ -11,6 +11,10 @@
 
     The process will return a buffer containing a time series that describes the novelty feature changing over time in the source buffer.
 
+    .. only_in:: sc
+
+      The argument for ``algorithm`` can be passed as an integer (see table below), or as one of the following symbols: ``\spectrum``, ``\mfcc``, ``\chroma``, ``\pitch``, or ``\loudness``. 
+
 :process: This is the method that calls for the slicing to be calculated on a given source buffer.
 :output: Nothing, as the various destination buffers are declared in the function call.
 
@@ -51,7 +55,7 @@
          MFCC – 13 Mel-Frequency Cepstrum Coefficients.
 
       :2:
-         Chroma - The contour of a 12-band chromagram.
+         Chroma – The contour of a 12-band chromagram.
 
       :3:
          Pitch – The pitch and its confidence.

doc/BufNoveltySlice.rst

@@ -9,6 +9,10 @@
 
    The process will return a buffer which contains indices (in sample) of estimated starting points of different slices.
 
+   .. only_in:: sc
+
+      The argument for ``algorithm`` can be passed as an integer (see table below), or as one of the following symbols: ``\spectrum``, ``\mfcc``, ``\chroma``, ``\pitch``, or ``\loudness``. 
+
 :process: This is the method that calls for the slicing to be calculated on a given source buffer.
 :output: Nothing, as the various destination buffers are declared in the function call.
 

doc/BufOnsetFeature.rst

@@ -9,6 +9,10 @@
 
    The metric for calculating difference can be chosen from a curated selection, lending the algorithm toward slicing a broad range of musical materials.
 
+   .. only_in:: sc
+
+      The argument for ``metric`` can be passed as an integer (see table below), or as one of the following symbols: ``\power``, ``\hfc``, ``\flux``,	``\mkl``, ``\is``, ``\cosine``, ``\phase``, ``\wphase``, ``\complex``, or ``\rcomplex``. 
+
 :process: This is the method that calls for the slicing to be calculated on a given source buffer.
 :output: Nothing, as the various destination buffers are declared in the function call.
 

doc/BufOnsetSlice.rst

@@ -9,6 +9,10 @@
 
    The metric for calculating difference can be chosen from a curated selection, lending the algorithm toward slicing a broad range of musical materials.
 
+   .. only_in:: sc
+
+      The argument for ``metric`` can be passed as an integer (see table below), or as one of the following symbols: ``\power``, ``\hfc``, ``\flux``,	``\mkl``, ``\is``, ``\cosine``, ``\phase``, ``\wphase``, ``\complex``, or ``\rcomplex``. 
+
 :process: This is the method that calls for the slicing to be calculated on a given source buffer.
 :output: Nothing, as the various destination buffers are declared in the function call.
 

doc/NoveltyFeature.rst

@@ -9,6 +9,10 @@
 
    Novelty derived by running a kernel across the diagonal of the similarity matrix. It implements the seminal results published in  'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote.
 
+   .. only_in:: sc
+
+      The argument for ``algorithm`` can be passed as an integer (see table below) which is modulatable, or as one of the following symbols: ``\spectrum``, ``\mfcc``, ``\chroma``, ``\pitch``, or ``\loudness``. 
+
 :process: The audio rate version of the object.
 :output: A KR signal of the feature.
 

doc/NoveltySlice.rst

@@ -9,6 +9,10 @@
 
    The process will return an audio stream with single sample impulses at estimated starting points of the different slices.
 
+   .. only_in:: sc
+
+      The argument for ``algorithm`` can be passed as an integer (see table below) which is modulatable, or as one of the following symbols: ``\spectrum``, ``\mfcc``, ``\chroma``, ``\pitch``, or ``\loudness``. 
+
 :output: An audio stream with impulses at detected transients. The latency between the input and the output is hopSize * (((kernelSize+1)/2).asInteger + ((filterSize + 1) / 2).asInteger + 1) samples at maximum.
 
 

doc/OnsetFeature.rst

@@ -9,6 +9,10 @@
 
    The metric for calculating difference can be chosen from a curated selection, lending the algorithm toward slicing a broad range of musical materials.
 
+   .. only_in:: sc
+
+      The argument for ``metric`` can be passed as an integer (see table below) which is modulatable, or as one of the following symbols: ``\power``, ``\hfc``, ``\flux``,	``\mkl``, ``\is``, ``\cosine``, ``\phase``, ``\wphase``, ``\complex``, or ``\rcomplex``. 
+
 :process: The audio rate version of the object.
 :output: A KR signal of the feature.
 

doc/OnsetSlice.rst

@@ -9,6 +9,10 @@
 
    The metric for calculating difference can be chosen from a curated selection, lending the algorithm toward slicing a broad range of musical materials.
 
+   .. only_in:: sc
+
+      The argument for ``metric`` can be passed as an integer (see table below) which is modulatable, or as one of the following symbols: ``\power``, ``\hfc``, ``\flux``,	``\mkl``, ``\is``, ``\cosine``, ``\phase``, ``\wphase``, ``\complex``, or ``\rcomplex``. 
+
 :process: The audio rate version of the object.
 :output: An audio stream with impulses at detected transients. The latency between the input and the output is windowSize at maximum.