diff options
| author | Abhinav Dronamraju | 2017-11-29 17:34:00 +0530 |
|---|---|---|
| committer | Abhinav Dronamraju | 2017-11-29 17:34:00 +0530 |
| commit | d97df53d72f66db206da540e909679fa863b51b6 (patch) | |
| tree | d771887f58498d5b6fc4c6d1efe0db0376e7a043 /help/en_US/diffpara.xml | |
| parent | 9539b5efb5ccf665a1cc4b8e814e96460b22e0ab (diff) | |
| download | FOSSEE-Signal-Processing-Toolbox-d97df53d72f66db206da540e909679fa863b51b6.tar.gz FOSSEE-Signal-Processing-Toolbox-d97df53d72f66db206da540e909679fa863b51b6.tar.bz2 FOSSEE-Signal-Processing-Toolbox-d97df53d72f66db206da540e909679fa863b51b6.zip | |
Added xml files and new functions
Diffstat (limited to 'help/en_US/diffpara.xml')
| -rw-r--r-- | help/en_US/diffpara.xml | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/help/en_US/diffpara.xml b/help/en_US/diffpara.xml new file mode 100644 index 0000000..be0f99c --- /dev/null +++ b/help/en_US/diffpara.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from diffpara.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="diffpara" 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>diffpara</refname> + <refpurpose>Return the estimator D for the differencing parameter of an integrated time series</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [D, DD] = diffpara (X) + [D, DD] = diffpara (X, A) + [D, DD] = diffpara (X, A, B) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X:</term> + <listitem><para> Input scalar or vector.</para></listitem></varlistentry> + <varlistentry><term>DD:</term> + <listitem><para>The estimators for all frequencies in the intervals described above.</para></listitem></varlistentry> + <varlistentry><term>D:</term> + <listitem><para>The mean of DD</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Return the estimator D for the differencing parameter of an integrated time series. + </para> + <para> +The frequencies from [2*pi*a/t, 2*pi*b/T] are used for the estimation. If B is omitted, the interval [2*pi/T, 2*pi*a/T] is used. If both B and A are omitted then a = 0.5 * sqrt (T) and b = 1.5 * sqrt (T) is used, where T is the sample size. If X is a matrix, the differencing parameter of each column is estimated. + </para> + <para> +The estimators for all frequencies in the intervals described above is returned in DD. + </para> + <para> +The value of D is simply the mean of DD. +</para> +</refsection> +</refentry> |