updated some of the help files to remove 'labelled' langugae and replace it with 'identifier' language

nix
Ted Moore 4 years ago
parent afe6b31fbc
commit 78a7418fef

@ -1,5 +1,5 @@
TITLE:: FluidDataSet TITLE:: FluidDataSet
summary:: Container for labelled, multidimensional data summary:: Container that associates data points with identifiers
categories:: Libraries>FluidCorpusManipulation categories:: Libraries>FluidCorpusManipulation
related:: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKMeans related:: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKMeans

@ -4,7 +4,7 @@ categories:: Libraries>FluidCorpusManipulation
related:: Classes/FLuidDataSet related:: Classes/FLuidDataSet
DESCRIPTION:: DESCRIPTION::
A UGen that adds labelled points to a link::Classes/FluidDataSet:: Internally, this calls code::setPoint::, so IDs that already exist will be overwritten, and new IDs will be added. The actual work is done on the server's command queue, rather than the real-thread. A UGen that adds data points with associated identifiers to a link::Classes/FluidDataSet:: Internally, this calls code::setPoint::, so IDs that already exist will be overwritten, and new IDs will be added. The actual work is done on the server's command queue, rather than the real-thread.
By default the object takes a control input (code::idNumber::) as a numerical index that gets used for the point identifiers. This index is used to write each time the Ugen is re-triggered with a zero to non-zero transition. The identifier is then concatenated with the code::idPrefix:: symbol, which is fixed at instantiation. In this way, one can make custom, incrementing identifiers, e.g. By default the object takes a control input (code::idNumber::) as a numerical index that gets used for the point identifiers. This index is used to write each time the Ugen is re-triggered with a zero to non-zero transition. The identifier is then concatenated with the code::idPrefix:: symbol, which is fixed at instantiation. In this way, one can make custom, incrementing identifiers, e.g.
@ -31,7 +31,7 @@ A string or symbol with a prefix for generated identifiers.
ARGUMENT:: idNumber ARGUMENT:: idNumber
ANCHOR::offset:: ANCHOR::offset::
An integer with the offset to start labeling from. If the UGen is run in a server-side loop (i.e. repeatedly re-triggered), the generated identifiers will count upwards from this offset. If nil, then no numerical index will be applied to the generated identifier (i.e. only the idPrefix is used). An integer with the offset to start creating identifiers from. If the UGen is run in a server-side loop (i.e. repeatedly re-triggered), the generated identifiers will count upwards from this offset. If nil, then no numerical index will be applied to the generated identifier (i.e. only the idPrefix is used).
ARGUMENT:: buf ARGUMENT:: buf
The link::Classes/Buffer:: containing the data point. The link::Classes/Buffer:: containing the data point.

@ -16,7 +16,7 @@ ARGUMENT:: path
A string pointing to a folder on disk A string pointing to a folder on disk
ARGUMENT:: idFunc ARGUMENT:: idFunc
A function that determines how the chunks in the index are labelled; default is file name without path. A function that determines how the identifiers for the chunks are created; default is file name without path.
ARGUMENT:: channelFunc ARGUMENT:: channelFunc
A funciton that controls what to do with differently wide files. Default behaviour is for loaded buffer to have as many channels as the widest file in the path, and for narrower files to repeat their channels across this buffer. The funciton is passed the channels for the current file, the maximum channel count, and the current index. A funciton that controls what to do with differently wide files. Default behaviour is for loaded buffer to have as many channels as the widest file in the path, and for narrower files to repeat their channels across this buffer. The funciton is passed the channels for the current file, the maximum channel count, and the current index.

@ -66,7 +66,7 @@ section:: Analyse Data
subsection::Containers subsection::Containers
table:: table::
##link::Classes/FluidDataSet:: || Container for labelled, multidimensional data ##link::Classes/FluidDataSet:: || Container that associates data points with identifiers
##link::Classes/FluidLabelSet:: || Container of labels associated with IDs ##link::Classes/FluidLabelSet:: || Container of labels associated with IDs
:: ::
subsection:: Buffer Analysis subsection:: Buffer Analysis

Loading…
Cancel
Save