SF.net SVN: quarks:[2802] SenseWorld/HelpSource/Classes

[nescivi-Rn4VEauK+AKRv+]

Revision: 2802
http://sourceforge.net/p/quarks/code/2802
Author: nescivi
Date: 2014-10-15 19:40:13 +0000 (Wed, 15 Oct 2014)
Log Message:
-----------
SenseWorld: document the KurtosisUGen

Modified Paths:
--------------
SenseWorld/HelpSource/Classes/SkewUGen.schelp

Added Paths:
-----------
SenseWorld/HelpSource/Classes/KurtosisUGen.schelp

Added: SenseWorld/HelpSource/Classes/KurtosisUGen.schelp
===================================================================
--- SenseWorld/HelpSource/Classes/KurtosisUGen.schelp (rev 0)
+++ SenseWorld/HelpSource/Classes/KurtosisUGen.schelp 2014-10-15 19:40:13 UTC (rev 2802)
@@ -0,0 +1,28 @@
+TITLE:: KurtosisUGen
+summary:: Calculates the kurtosis of a signal over a specified time window.
+categories:: UGens>Analysis>Statistics
+related:: Classes/SkewUGen, Classes/StdDevUGen
+
+DESCRIPTION::
+KurtosisUGen is a pseudo UGen that calculates the skewness of a signal over a specified time window.
+
+Kurtosis is a measure of the "peakedness" of the probability distribution of a real-valued random variable.
+
+CLASSMETHODS::
+private:: categories
+
+METHOD:: kr
+Calculates the kurtosis of a control rate signal.
+
+ARGUMENT:: input
+The signal to calculate the kurtosis of.
+
+ARGUMENT:: length
+The length in samples of the window.
+
+ARGUMENT:: mean
+If you already calculate a mean (=RunningSum/length) in another part of your SynthDef you can supply it here, so it is not calculated again, thus safing processing power.
+
+
+INSTANCEMETHODS::
+

Modified: SenseWorld/HelpSource/Classes/SkewUGen.schelp
===================================================================
--- SenseWorld/HelpSource/Classes/SkewUGen.schelp 2014-10-12 23:42:07 UTC (rev 2801)
+++ SenseWorld/HelpSource/Classes/SkewUGen.schelp 2014-10-15 19:40:13 UTC (rev 2802)
@@ -15,7 +15,7 @@
Calculates the skewness of a control rate signal.

ARGUMENT:: input
-The signal to calculate the standard deviation of.
+The signal to calculate the skewness of.

ARGUMENT:: length
The length in samples of the window.

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


_______________________________________________
sc-dev mailing list

info (subscription, etc.): http://www.beast.bham.ac.uk/research/sc_mailing_lists.shtml
archive: http://www.listarc.bham.ac.uk/marchives/sc-dev/
search: http://www.listarc.bham.ac.uk/lists/sc-dev/search/