Git commit df844950d49cfa5afdefcaec786c5689d5bcecad by Stefan Gerlach.
Committed on 03/04/2016 at 10:19.
Pushed by sgerlach into branch 'filter'.

added analysis documentation (including Fourier filter)

M  +47   -5    doc/index.docbook

http://commits.kde.org/labplot/df844950d49cfa5afdefcaec786c5689d5bcecad

diff --git a/doc/index.docbook b/doc/index.docbook
index 18700a9..a61b348 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -38,7 +38,7 @@
 </authorgroup>
 
 <copyright>
-  <year>2007-2015</year>
+  <year>2007-2016</year>
        <holder>Stefan Gerlach</holder>
 </copyright>
 <copyright>
@@ -51,8 +51,8 @@
 </copyright>
 
 <legalnotice>&FDLNotice;</legalnotice>
-<date>2015-03-28</date>
-<releaseinfo>3.0</releaseinfo>
+<date>2016-04-03</date>
+<releaseinfo>3.1</releaseinfo>
 
 <abstract>
        <para>
@@ -776,6 +776,48 @@ The menu is only available when a datapicker object is 
selected on the <guilabel
   
 </chapter>
 
+<chapter id="analysis">
+  <title>Analysis functions</title>
+  <para>LabPlot supports the data analysis functions nonlinear curve fitting 
and Fourier filter.
+    Both can be applied to any data consisting of x- and y-columns. 
+    The analysis functions can be accessed using the Analysis menu or the 
context menu of a worksheet.</para>
+  <para>The newly created curves can be customized (line style, symbol style, 
etc.) like any x-y-curve.</para>  
+  <sect1 id="fitting">
+    <title>Curve fitting</title>
+    <para>
+      <!-- Linear and non-linear fits to data, several fit-models are 
predefined and custom models with 
+      arbitrary number of parameters can be provided -->
+      Linear and non-linear curve fitting of data can be done with several 
predefined fit-models 
+      (for instance polynomial, exponential, Gaussian or custom) to data 
consisting of x- and y-columns 
+      with an optional weigth column. With a custom model any function with 
unlimited number of parameters
+      can be used for fitting. The options (number of iterations, tolerance, 
number of fitted points) can
+      be used to optimize the fitting result which is displayed in the results 
text.
+    </para>
+  </sect1>
+  
+  <sect1 id="filter">
+    <title>Fourier filter</title>
+    <para>
+      This function can be used to apply a Fourier filter to any data 
consisting of x- and y-columns. Supported
+      filter types are:
+      <itemizedlist>
+       <listitem><para>Low pass</para></listitem>
+       <listitem><para>High pass</para></listitem>
+       <listitem><para>Band pass</para></listitem>
+       <listitem><para>Band reject (Band block)</para></listitem>
+       </itemizedlist>
+      where any of them can have the form
+      <itemizedlist>
+       <listitem><para>Ideal</para></listitem>
+       <listitem><para>Butterworth (order 1 to 10)</para></listitem>
+       <listitem><para>Chebyshev type I or II (order 1 to 10)</para></listitem>
+       </itemizedlist>
+       The cutoff value(s) can be specified in the units frequency (Hertz), 
fraction (0.0 to 1.0) or index 
+       of the data points.
+    </para>
+  </sect1>
+</chapter>
+
 <chapter id="digitization">
 <title>Curve Tracing</title>
 
@@ -1938,8 +1980,8 @@ needs a lot of work.
 
 <para>&LabPlot;</para>
 <para>
-Program copyright &copy; 2007-2015 Stefan Gerlach 
<email>[email protected]</email>
-Program copyright &copy; 2008-2015 Alexander Semke 
<email>[email protected]</email>
+Program copyright &copy; 2007-2016 Stefan Gerlach 
<email>[email protected]</email>
+Program copyright &copy; 2008-2016 Alexander Semke 
<email>[email protected]</email>
 </para>
 
 <important>
_______________________________________________
kde-doc-english mailing list
[email protected]
https://mail.kde.org/mailman/listinfo/kde-doc-english

Reply via email to