Update returns

nix
Owen Green 5 years ago
parent 36d91e37b8
commit 41780a255c

@ -76,8 +76,7 @@ The frequency of the fourth-order link::https://en.wikipedia.org/wiki/Linkwitz%E
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The metric will be passed indices as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -70,8 +70,7 @@ ARGUMENT:: highPassFreq
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The metric will be passed indices as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -51,8 +51,7 @@ ARGUMENT:: destGain
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and destination instance variables have been updated on the client side. The function will be passed destination as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
DISCUSSION::
It is important to understand the rules used for determining the final desintinaiton buffer dimensions to get the most out of this object. If needs be, the destination buffer will be resized to the maxima of the requsted source numFrames and numChannels. Frames will be written up to the limit of actually available samples (meaning you can create zero padding); channels will be written modulo the available channels, taking into account the channel offsets, meaning you can have channels repeat or loop into the source buffer's channels. See the examples below.

@ -65,6 +65,8 @@ Whether to group points channel-wise or frame-wise
ARGUMENT:: trig
Trigger signal to defer / retrigger processing
returns:: an instance of the processor
EXAMPLES::
code::
@ -89,4 +91,4 @@ FluidBufFlatten.process(s,~pitchdata,~flatdata,axis:1,action:{
})
})
)
::
::

@ -105,8 +105,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [harmonic, percussive, residual] as an argument.
RETURNS::
Nothing, as the various destination buffers are declared in the function call.
returns:: an instance of the processor
Discussion::
HPSS works by using median filters on the spectral magnitudes of a sound. It hinges on a simple modelling assumption that tonal components will tend to yield concentrations of energy across time, spread out in frequency, and percussive components will manifest as concentrations of energy across frequency, spread out in time. By using median filters across time and frequency respectively, we get initial esitmates of the tonal-ness / transient-ness of a point in time and frequency. These are then combined into 'masks' that are applied to the orginal spectral data in order to produce a separation.

@ -54,8 +54,7 @@ ARGUMENT:: hopSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [features] as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -62,8 +62,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [features] as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -63,8 +63,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [features] as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -105,8 +105,7 @@ ARGUMENT:: randomSeed
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [resynth, bases, activations] as an argument.
RETURNS::
Nothing, as the various destination buffers are declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -55,6 +55,7 @@ The analsyis FFT size in samples (default = winSize)
ARGUMENT:: action
A function to run when processing is complete, taking the output buffer as its argument
returns:: an instance of the processor
INSTANCEMETHODS::
@ -69,4 +70,4 @@ t = Buffer.read(s,~path+/+"Tremblay-SA-UprightPianoPedalWide.wav")
o = Buffer.new
FluidBufNMFCross.process(s,t,b,o,action:{"Ding".postln})
o.play
::
::

@ -56,6 +56,9 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [destination] as an argument.
returns:: an instance of the processor
INSTANCEMETHODS::
private:: synth, server

@ -70,8 +70,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The function will be passed indices as an argument.
RETURNS::
Nothing, as the various destination buffers are declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -77,8 +77,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The function will be passed indices as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -68,8 +68,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [features] as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -52,8 +52,7 @@ The output value when the input is inputHigh
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The metric will be passed indices as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -85,8 +85,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [sines, residual] as an argument.
RETURNS::
Nothing, as the various destination buffers are declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -67,8 +67,7 @@ ARGUMENT:: fftSize
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [features] as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -64,8 +64,7 @@ ARGUMENT:: weights
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The function will be passed stats as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -27,8 +27,7 @@ ARGUMENT:: time
ARGUMENT:: action
A function that will be executed upon completion. It is passed the destination buffer as argument.
RETURNS::
The instance of FluidNRTProcess which can be used to cancel the job.
returns::The instance of FluidNRTProcess which can be used to cancel the job.
METHOD:: kr
@ -43,8 +42,7 @@ ARGUMENT:: time
ARGUMENT:: doneAction
An integer representing an action to be executed when the process is finished. This can be used to free the enclosing synth, etc. See link::Classes/Done:: for more detail.
RETURNS::
It report the approximate job progress, from 0 to 1.
returns::It report the approximate job progress, from 0 to 1.
EXAMPLES::

@ -44,8 +44,7 @@ The threshold under which values will be zeroed
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The metric will be passed indices as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -68,8 +68,7 @@ ARGUMENT:: minSliceLength
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and indices instance variables have been updated on the client side. The function will be passed indices as an argument.
RETURNS::
Nothing, as the destination buffer is declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -72,8 +72,7 @@ ARGUMENT:: clumpLength
ARGUMENT:: action
A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [transients, residual] as an argument.
RETURNS::
Nothing, as the various destination buffers are declared in the function call.
returns:: an instance of the processor
EXAMPLES::

@ -129,7 +129,7 @@ For instance, whilst fitting the tree against some n-dimensional descriptor data
code::
(
,(
Routine{
var inputBuffer = Buffer.alloc(s,2);
var outputBuffer = Buffer.alloc(s,10);//5 neighbours * 2D data points
@ -157,8 +157,7 @@ fork{
~dsL.load(d, {~dsL.print});
}
)
~dsL.asUGenInput
s.dumpOSC
// Create the buffers, and make a synth, querying our tree with some random points
(
Routine{

@ -63,9 +63,9 @@ code::
//Preliminaries: we want some audio, a couple of FluidDataSets, some Buffers, a FluidStandardize and a FluidMDS
(
~audiofile = File.realpath(FluidBufPitch.class.filenameSymbol).dirname +/+ "../AudioFiles/Tremblay-ASWINE-ScratchySynth-M.wav";
~raw = FluidDataSet(s,\mds_help_12D);
~standardized = FluidDataSet(s,\mds_help_12Ds);
~reduced = FluidDataSet(s,\mds_help_2D);
~raw = FluidDataSet(s);
~standardized = FluidDataSet(s);
~reduced = FluidDataSet(s);
~audio = Buffer.read(s,~audiofile);
~mfcc_feature = Buffer.new(s);
~stats = Buffer.alloc(s, 7, 12);
@ -108,11 +108,9 @@ FluidBufMFCC.process(s,~audio, features: ~mfcc_feature);
//Then apply the MDS in-place on the standardized data to get 2 dimensions, using a Euclidean distance metric
//Download the DataSet contents into an array for plotting
(
~reducedarray = Array.new(100);
~standardizer.fitTransform(~raw, ~standardized);
~mds.fitTransform(~standardized, ~reduced, action:{
"HETE".postln;
~reduced.dump{|x| 100.do{|i|
~reducedarray.add(x["data"][i.asString])
}}});

Loading…
Cancel
Save