diff options
| author | bgtushar | 2017-11-30 12:13:24 +0530 |
|---|---|---|
| committer | GitHub | 2017-11-30 12:13:24 +0530 |
| commit | 14d0ad8d846d12b3c82b0b5bc4ffd4d1360ec288 (patch) | |
| tree | bfb2e64ccc143e3affaa88fea05c72fa1207ab10 /help/en_US/detrend1.xml | |
| parent | 8e9af4404bedd0fc7ff9c34bf8b794d6b8602b36 (diff) | |
| parent | 61f5e86e353f1332928e716cf9c730b4c5ec357d (diff) | |
| download | FOSSEE-Signal-Processing-Toolbox-14d0ad8d846d12b3c82b0b5bc4ffd4d1360ec288.tar.gz FOSSEE-Signal-Processing-Toolbox-14d0ad8d846d12b3c82b0b5bc4ffd4d1360ec288.tar.bz2 FOSSEE-Signal-Processing-Toolbox-14d0ad8d846d12b3c82b0b5bc4ffd4d1360ec288.zip | |
Merge pull request #7 from abhinavdronamraju/master
Merge and add functions
Diffstat (limited to 'help/en_US/detrend1.xml')
| -rw-r--r-- | help/en_US/detrend1.xml | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/help/en_US/detrend1.xml b/help/en_US/detrend1.xml new file mode 100644 index 0000000..783d922 --- /dev/null +++ b/help/en_US/detrend1.xml @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from detrend1.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="detrend1" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:scilab="http://www.scilab.org" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>detrend1</refname> + <refpurpose>This function removes the best fit of a polynomial of order P from the data X</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + detrend1(X,P) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X:</term> + <listitem><para> Input vecor or matrix.</para></listitem></varlistentry> + <varlistentry><term>P:</term> + <listitem><para> The order of polnomial</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +If X is a vector, 'detrend1(X, P)' removes the best fit of apolynomial of order P from the data X.If X is a matrix, 'detrend1(X, P)' does the same for each column in X. + </para> + <para> +The second argument P is optional. If it is not specified, a value of 1 is assumed. This corresponds to removing a linear trend. +The order of the polynomial can also be given as a string, in which case P must be either "constant" (corresponds to 'P=0') or "linear"(corresponds to 'P=1') +</para> +</refsection> +</refentry> |