[Kst] branches/work/kst/1.6/doc/kst

[Yiwen Mao]

SVN commit 765042 by yiwenmao:

updated docbook

 M  +417 -1    plugins-chapter.docbook  


--- branches/work/kst/1.6/doc/kst/plugins-chapter.docbook #765041:765042
@@ -15,8 +15,15 @@
 </sect1>
 
 <sect1 id="plugins-builtindescriptions">
-<title>Built-in Plugins</title>
+<title>Built-in Plugins</title><varlistentry>
+<term>Input scalar-NSigma:</term>
+<listitem>
 <para>
+Define the degree of abnormality of the data value to be counted as a spike.
+</para>
+</listitem>
+</varlistentry>
+<para>
 There are over 25 built-in plugins available in &kst; that perform functions from taking cross correlations of two vectors to producing periodograms of a data set.
 </para>
 
@@ -158,6 +165,90 @@
 
 </sect2>
 
+
+</sect2>
+
+<sect2 id="plugins-binnnedmap">
+<title>Binned Map</title>
+<para>
+The binned map generates a surface countor plot of a two-variable function
+</para>
+
+<screenshot>
+<screeninfo>plugins binnedmap</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="Screenshot-kst-plugins-binnedmap.png
+" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>Edit Binned Map</phrase>
+</textobject>
+</mediaobject>
+</screenshot> 
+
+<sect3 id="plugins-binnedmap-Settings">
+<title>Settings</title>
+<variablelist>
+
+<varlistentry>
+<term>X,Y,Z(vector)</term>
+<listitem>
+<para>
+X/Y vectors are used to specify the values of the two independent variables in the function, and the Z vector is the dependent variable.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>X/Y Binning:</term>
+<listitem>
+<para>
+Specify the range of X/Y values.
+</para>
+</listitem>
+</varlistentry>
+
+
+<varlistentry>
+<term>Num X/Y bins:</term>
+<listitem>
+<para>
+Specify the number of resolution grid for the output binned map.
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+<sect3 id="plugins-binnedmaps-outputs">
+<title>Outputs</title>
+<variablelist>
+
+<varlistentry>
+<term>Binned Map</term>
+<listitem>
+<para>
+Binned Map is a matrix which places each value of the Z vector into its corresponding position in the X/Y plane specified by the range of X/Y binning, and the size of the matrix is specified by the number of X/Y bins. An image of color contour plot of Z vector in X/Y space can be generated by plotting the matrix: Binned Map.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Hits Map</term>
+<listitem>
+<para>
+Hits Map is a matrix whose values specified the number of points in each X/Y bin, and the image of Hits Map indicates the position where the Z value has been located in the X/Y plane.
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+</sect2>
+
 <sect2 id="plugins-butterworth_bandpass">
 <title>Band-pass filter</title>
 <para>
@@ -603,6 +694,197 @@
 </sect2>
 
 
+
+
+<sect2 id="plugins-crosspowerspectrum">
+<title>Cross Power Spectrum</title>
+<para>
+The cross power spectrum plugin calculates the correlated power spectra of two vectors. It is calculated according to:
+</para>
+<para>
+<inlinemediaobject>
+<imageobject>
+<imagedata fileref="formula-kst-crosspowerspectrum.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>crosscorrelation formula</phrase>
+</textobject>
+</inlinemediaobject>
+</para>
+<para>
+rx1x2 is the <link linkend="plugins-crosscorrelation">crosscorelation</link> of the two input vectors.
+</para>
+
+<screenshot>
+<screeninfo>plugins-Edit Cross Power Spectrum</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="Screenshot-kst-plugins-crosspowerspectrum.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>crosspower spectrum</phrase>
+</textobject>
+</mediaobject>
+</screenshot> 
+
+<sect3 id="plugins-crosspowerspectrum-Inputs">
+<title>Inputs</title>
+<variablelist>
+
+<varlistentry>
+<term>Vector One/Two</term>
+<listitem>
+<para>
+The two vectors used to calculate the cross power spectrum
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>FFT Length= 2^:</term>
+<listitem>
+<para>
+Refer to FFT options in <Link linkend="data-types-spectrum">Spectrum</Link>.
+</para>
+</listitem>
+</varlistentry>
+
+
+<varlistentry>
+<term>Sample rate</term>
+<listitem>
+<para>
+refer to FFT options in <Link linkend="data-types-spectrum">Spectrum</Link>.
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+<sect3 id="plugins-crosspowerspectrum-outputs">
+<title>Outputs</title>
+<variablelist>
+
+<varlistentry>
+<term>Cross Spectrum: Real(vector)</term>
+<listitem>
+<para>
+The real part of the calculated cross power spectrum.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Cross Spectrum: Imaginary (vector)</term>
+<listitem>
+<para>
+The imaginary part of the calculated cross power spectrum.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Frequency(vector)</term>
+<listitem>
+<para>
+The frequency of the output cross power spectrum.
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+</sect2>
+<sect2 id="plugins-cumulativesum(integral)">
+<title>Cumulative Sum(integral)</title>
+<para>
+This plugin sums up the input vector cumulatively over a chosen time step according to the formula:
+</para>
+
+<para>
+<inlinemediaobject>
+<imageobject>
+<imagedata fileref="formula-kst-cumulativesum.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>Cumulativesum Formula</phrase>
+</textobject>
+</inlinemediaobject>
+</para>
+<para>
+
+<screenshot>
+<screeninfo>Edit Cumulative Sum(integral)</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="Screenshot-kst-plugins-cumulativesum.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>Edit Cumulative Sum(integr<varlistentry>
+<term>Frequency(vector)</term>
+<listitem>
+<para>
+The frequency of the output cross power spectrum.
+</para>
+</listitem>
+</varlistentry>al)</phrase>
+</textobject>
+</mediaobject>
+</screenshot> 
+
+<sect3 id="plugins-cumulativesum-Inputs">
+<title>Inputs</title><varlistentry>
+<term>Frequency(vector)</term>
+<listitem>
+<para>
+The frequency of the output cross power spectrum.
+</para>
+</listitem>
+</varlistentry>
+<variablelist>
+
+<varlistentry>
+<term>InputVector</term>
+<listitem>
+<para>
+The vector used to calculate the cumulative sum.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Scale factor(time step)(Scalar)</term>
+<listitem>
+<para>
+The interval size for each step of calculating cumulative sum,i.e dt in the formula
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+<sect3 id="plugins-cumulativesum-outputs">
+<title>Outputs</title>
+<variablelist>
+
+<varlistentry>
+<term>Cumulative Sum (Vector)</term>
+<listitem>
+<para>
+The cumulative sum for each step
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+</sect2>
+
+
 <sect2 id="plugins-deconvolution">
 <title>Deconvolution</title>
 <para>
@@ -674,7 +956,79 @@
 
 </sect2>
 
+</sect2>
 
+<sect2 id="plugins-despikefilter">
+<title>Despike Filter</title>
+<para>
+This plugin is used to find and remove spikes in a data set.
+</para>
+
+<screenshot>
+<screeninfo>plugins-Edit Despike Filter</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="Screenshot-kst-plugins-despikefilter.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>Edit Despike Filter</phrase>
+</textobject>
+</mediaobject>
+</screenshot> 
+
+<sect3 id="plugins-despike-filter">
+<title>Inputs</title>
+<variablelist>
+
+<varlistentry>
+<term>Input vector-Y</term>
+<listitem>
+<para>
+Select the data vector needed to be smoothed.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Input scalar - Spacing:</term>
+<listitem>
+<para>
+Specify the width of the spikes.
+Its value should be larger than 1.
+</para>
+</listitem>
+</varlistentry>
+
+
+<varlistentry>
+<term>Input scalar-NSigma:</term>
+<listitem>
+<para>
+Define the degree of abnormality of the data value to be counted as a spike.
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+<sect3 id="plugins-despikefilter-outputs">
+<title>Outputs</title>
+<variablelist>
+
+<varlistentry>
+<term>Output vector-Despiked:</term>
+<listitem>
+<para>
+This plugin outputs a smoothed data set with all specified spikes removed.
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+</sect2>
 <sect2 id="plugins-kstfit_exponential_weighted">
 <title>Fit exponential weighted</title>
 <para>
@@ -1711,7 +2065,69 @@
 Weights (vector) input does not exist.
 </para>
 </sect2>
+</sect2>
 
+<sect2 id="plugins-fixedstepdifferentiation">
+<title>Fixed Step Differentiation</title>
+<para>
+This plugin calculates derivative value of each time step for an input vector using the second order discretization: derv[i] = (data[i+1]-data[i])2*timestep.
+</para>
+
+<screenshot>
+<screeninfo>plugins-Edit fixed step differentiation</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="Screenshot-kst-plugins-fixedstepdifferentiation.png" format="PNG" />
+</imageobject>
+<textobject>
+<phrase>Edit fixed step differentiation</phrase>
+</textobject>
+</mediaobject>
+</screenshot> 
+
+<sect3 id="plugins-fixedstepdifferentiation">
+<title>Inputs</title>
+<variablelist>
+
+<varlistentry>
+<term>inputVector</term>
+<listitem>
+<para>
+the data vector to take derivative of
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Time step(scalar)</term>
+<listitem>
+<para>
+Specify the size of the time interval between any two neighbour values in the input vector
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+<sect3 id="plugins-fixedstepdifferentiation-outputs">
+<title>Outputs</title>
+<variablelist>
+
+<varlistentry>
+<term>Derivative(vector)</term>
+<listitem>
+<para>
+This plugin outputs derivative values for every timestep.
+</para>
+</listitem>
+</varlistentry>
+
+</variablelist>
+</sect3>
+
+</sect2>
+
 <sect2 id="plugins-kstinterp_akima">
 <title>Interpolation Akima spline</title>
 <para>