[Kst] www/areas/extragear/apps/kst/kstscript/docs
Andrew Walker
arwalker at sumusltd.com
Mon Aug 25 22:09:28 CEST 2008
SVN commit 852378 by arwalker:
update documentation
M +12 -2 BinnedMap.html
M +5 -1 Curve.html
M +1 -1 Plugin.html
M +5 -1 PowerSpectrum.html
M +5 -1 Spectrogram.html
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/BinnedMap.html #852377:852378
@@ -16,16 +16,26 @@
<br>
Inherits: <a class="link" href="DataObject.html">DataObject</a><br>
</div>
-<br><span class="title">Methods:</span><ul>
+<br><span class="title">Constructors:</span><ul>
+<a class="link" href="#constructor_1">BinnedMap</a> ( )<br>
+</ul>
+<span class="title">Methods:</span><ul>
<a class="link" href="#method_validate">validate</a> ( )<br>
</ul>
<span class="title">Properties:</span><ul>
<a class="link" href="#property_x">x</a><br><a class="link" href="#property_y">y</a><br><a class="link" href="#property_z">z</a><br><a class="link" href="#property_binnedMap">binnedMap</a><br><a class="link" href="#property_hitsMap">hitsMap</a><br><a class="link" href="#property_xFrom">xFrom</a><br><a class="link" href="#property_xTo">xTo</a><br><a class="link" href="#property_yFrom">yFrom</a><br><a class="link" href="#property_yTo">yTo</a><br><a class="link" href="#property_nX">nX</a><br><a class="link" href="#property_nY">nY</a><br><a class="link" href="#property_autobin">autobin</a><br><a class="link" href="#property_valid">valid</a><br>
</ul>
<hr>
-<br><span class="subTitle"><a name="method_validate"></a><b>void validate ( )</b></span><br><ul>
+<br><span class="subTitle"><a name="constructor_1"></a><b>BinnedMap ( )</b></span><br><ul>
<div class="parameters"></div>
<p>
+ Main constructor for the BinnedMap class.
+
+ </p>
+</ul>
+<br><br><span class="subTitle"><a name="method_validate"></a><b>void validate ( )</b></span><br><ul>
+<div class="parameters"></div>
+<p>
Validates the plugin.
</p>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Curve.html #852377:852378
@@ -23,7 +23,7 @@
<a class="link" href="#method_point">point</a> ( index )<br><a class="link" href="#method_xErrorPoint">xErrorPoint</a> ( index )<br><a class="link" href="#method_yErrorPoint">yErrorPoint</a> ( index )<br><a class="link" href="#method_xMinusErrorPoint">xMinusErrorPoint</a> ( index )<br><a class="link" href="#method_yMinusErrorPoint">yMinusErrorPoint</a> ( index )<br>
</ul>
<span class="title">Properties:</span><ul>
-<a class="link" href="#property_color">color</a><br><a class="link" href="#property_xVector">xVector</a><br><a class="link" href="#property_yVector">yVector</a><br><a class="link" href="#property_xErrorVector">xErrorVector</a><br><a class="link" href="#property_yErrorVector">yErrorVector</a><br><a class="link" href="#property_xMinusErrorVector">xMinusErrorVector</a><br><a class="link" href="#property_xMinusErrorVector">xMinusErrorVector</a><br><a class="link" href="#property_samplesPerFrame">samplesPerFrame</a><br><a class="link" href="#property_ignoreAutoScale">ignoreAutoScale</a><br><a class="link" href="#property_hasPoints">hasPoints</a><br><a class="link" href="#property_hasLines">hasLines</a><br><a class="link" href="#property_hasBars">hasBars</a><br><a class="link" href="#property_lineWidth">lineWidth</a><br><a class="link" href="#property_pointStyle">pointStyle</a><br><a class="link" href="#property_lineStyle">lineStyle</a><br><a class="link" href="#property_barStyle"
>barStyle</a><br><a class="link" href="#property_pointDensity">pointDensity</a><br><a class="link" href="#property_topLabel">topLabel</a><br><a class="link" href="#property_xLabel">xLabel</a><br><a class="link" href="#property_yLabel">yLabel</a><br><a class="link" href="#property_legendText">legendText</a><br>
+<a class="link" href="#property_color">color</a><br><a class="link" href="#property_xVector">xVector</a><br><a class="link" href="#property_yVector">yVector</a><br><a class="link" href="#property_xErrorVector">xErrorVector</a><br><a class="link" href="#property_yErrorVector">yErrorVector</a><br><a class="link" href="#property_xMinusErrorVector">xMinusErrorVector</a><br><a class="link" href="#property_xMinusErrorVector">xMinusErrorVector</a><br><a class="link" href="#property_yVectorOffset">yVectorOffset</a><br><a class="link" href="#property_samplesPerFrame">samplesPerFrame</a><br><a class="link" href="#property_ignoreAutoScale">ignoreAutoScale</a><br><a class="link" href="#property_hasPoints">hasPoints</a><br><a class="link" href="#property_hasLines">hasLines</a><br><a class="link" href="#property_hasBars">hasBars</a><br><a class="link" href="#property_lineWidth">lineWidth</a><br><a class="link" href="#property_pointStyle">pointStyle</a><br><a class="link" href="#property_l
ineStyle">lineStyle</a><br><a class="link" href="#property_barStyle">barStyle</a><br><a class="link" href="#property_pointDensity">pointDensity</a><br><a class="link" href="#property_topLabel">topLabel</a><br><a class="link" href="#property_xLabel">xLabel</a><br><a class="link" href="#property_yLabel">yLabel</a><br><a class="link" href="#property_legendText">legendText</a><br>
</ul>
Collection class: <a class="link" href="CurveCollection.html">CurveCollection</a><br><hr>
<br><span class="subTitle"><a name="constructor_1"></a><b>Curve ( <a class="link" href="Vector.html">Vector</a> x, <a class="link" href="Vector.html">Vector</a> y [, <a class="link" href="Vector.html">Vector</a> xError [, <a class="link" href="Vector.html">Vector</a> yError [, <a class="link" href="Vector.html">Vector</a> xMinusError [, <a class="link" href="Vector.html">Vector</a> yMinusError]]]] )</b></span><br><ul>
@@ -179,6 +179,10 @@
The X axis negative error vector for the curve.
</p></ul>
+<br><br><span class="subTitle"><a name="property_yVectorOffset"></a><b><a class="link" href="Scalar.html">Scalar</a> yVectorOffset</b></span><br><ul><p>
+ The offset to be applied to the y-axis vector.
+
+ </p></ul>
<br><br><span class="subTitle"><a name="property_samplesPerFrame"></a><b>number samplesPerFrame [Read-Only]</b></span><br><ul><p>
The number of samples per frame for the curve.
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Plugin.html #852377:852378
@@ -37,7 +37,7 @@
[OPTIONAL]<br>
</div>
<p>
- Main constructor for the Plugini class. New plugins are
+ Main constructor for the Plugin class. New plugins are
typically invalid until various properties have been set.
</p>
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/PowerSpectrum.html #852377:852378
@@ -20,7 +20,7 @@
<a class="link" href="#constructor_1">PowerSpectrum</a> ( vector, freq [, average [, len [, apodize [, removeMean]]]] )<br>
</ul>
<span class="title">Properties:</span><ul>
-<a class="link" href="#property_length">length</a><br><a class="link" href="#property_output">output</a><br><a class="link" href="#property_removeMean">removeMean</a><br><a class="link" href="#property_average">average</a><br><a class="link" href="#property_apodize">apodize</a><br><a class="link" href="#property_apodizeFn">apodizeFn</a><br><a class="link" href="#property_frequency">frequency</a><br><a class="link" href="#property_xVector">xVector</a><br><a class="link" href="#property_yVector">yVector</a><br><a class="link" href="#property_vUnits">vUnits</a><br><a class="link" href="#property_rUnits">rUnits</a><br><a class="link" href="#property_interpolateHoles">interpolateHoles</a><br>
+<a class="link" href="#property_vector">vector</a><br><a class="link" href="#property_length">length</a><br><a class="link" href="#property_output">output</a><br><a class="link" href="#property_removeMean">removeMean</a><br><a class="link" href="#property_average">average</a><br><a class="link" href="#property_apodize">apodize</a><br><a class="link" href="#property_apodizeFn">apodizeFn</a><br><a class="link" href="#property_frequency">frequency</a><br><a class="link" href="#property_xVector">xVector</a><br><a class="link" href="#property_yVector">yVector</a><br><a class="link" href="#property_vUnits">vUnits</a><br><a class="link" href="#property_rUnits">rUnits</a><br><a class="link" href="#property_interpolateHoles">interpolateHoles</a><br>
</ul>
Collection class: <a class="link" href="PowerSpectrumCollection.html">PowerSpectrumCollection</a><br><hr>
<br><span class="subTitle"><a name="constructor_1"></a><b>PowerSpectrum ( <a class="link" href="Vector.html">Vector</a> vector, number freq [, boolean average [, number len [, boolean apodize [, boolean removeMean]]]] )</b></span><br><ul>
@@ -52,6 +52,10 @@
</p>
</ul>
+<br><br><span class="subTitle"><a name="property_vector"></a><b><a class="link" href="Vector.html">Vector</a> vector</b></span><br><ul><p>
+ The input vector for the power spectrum.
+
+ </p></ul>
<br><br><span class="subTitle"><a name="property_length"></a><b>number length</b></span><br><ul><p>
Contains the base 2 logarithm of the length to be used for interleaved averaging. Should be an integer >= 4.
--- trunk/www/areas/extragear/apps/kst/kstscript/docs/Spectrogram.html #852377:852378
@@ -20,7 +20,7 @@
<a class="link" href="#constructor_1">Spectrogram</a> ( vector, freq [, average [, len [, apodize [, removeMean]]]] )<br>
</ul>
<span class="title">Properties:</span><ul>
-<a class="link" href="#property_length">length</a><br><a class="link" href="#property_output">output</a><br><a class="link" href="#property_removeMean">removeMean</a><br><a class="link" href="#property_average">average</a><br><a class="link" href="#property_apodize">apodize</a><br><a class="link" href="#property_apodizeFn">apodizeFn</a><br><a class="link" href="#property_frequency">frequency</a><br><a class="link" href="#property_matrix">matrix</a><br><a class="link" href="#property_vUnits">vUnits</a><br><a class="link" href="#property_rUnits">rUnits</a><br><a class="link" href="#property_windowSize">windowSize</a><br><a class="link" href="#property_interpolateHoles">interpolateHoles</a><br>
+<a class="link" href="#property_vector">vector</a><br><a class="link" href="#property_length">length</a><br><a class="link" href="#property_output">output</a><br><a class="link" href="#property_removeMean">removeMean</a><br><a class="link" href="#property_average">average</a><br><a class="link" href="#property_apodize">apodize</a><br><a class="link" href="#property_apodizeFn">apodizeFn</a><br><a class="link" href="#property_frequency">frequency</a><br><a class="link" href="#property_matrix">matrix</a><br><a class="link" href="#property_vUnits">vUnits</a><br><a class="link" href="#property_rUnits">rUnits</a><br><a class="link" href="#property_windowSize">windowSize</a><br><a class="link" href="#property_interpolateHoles">interpolateHoles</a><br>
</ul>
Collection class: <a class="link" href="SpectrogramCollection.html">SpectrogramCollection</a><br><hr>
<br><span class="subTitle"><a name="constructor_1"></a><b>Spectrogram ( <a class="link" href="Vector.html">Vector</a> vector, number freq [, boolean average [, number len [, boolean apodize [, boolean removeMean]]]] )</b></span><br><ul>
@@ -52,6 +52,10 @@
</p>
</ul>
+<br><br><span class="subTitle"><a name="property_vector"></a><b><a class="link" href="Vector.html">Vector</a> vector</b></span><br><ul><p>
+ The input vector for the spectrogram.
+
+ </p></ul>
<br><br><span class="subTitle"><a name="property_length"></a><b>number length</b></span><br><ul><p>
Contains the base 2 logarithm of the length of the spectrogram.
Should be an integer >= 4.
More information about the Kst
mailing list