summaryrefslogtreecommitdiff
path: root/help
diff options
context:
space:
mode:
Diffstat (limited to 'help')
-rw-r--r--help/en_US/cceps.xml38
-rw-r--r--help/en_US/master_help.xml6
-rw-r--r--help/en_US/mscohere.xml57
-rw-r--r--help/en_US/scilab_en_US_help/JavaHelpSearch/DOCSbin10555 -> 10715 bytes
-rw-r--r--help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TABbin1409 -> 1429 bytes
-rw-r--r--help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETSbin661 -> 671 bytes
-rw-r--r--help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONSbin43320 -> 44032 bytes
-rw-r--r--help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA2
-rw-r--r--help/en_US/scilab_en_US_help/JavaHelpSearch/TMAPbin24576 -> 24576 bytes
-rw-r--r--help/en_US/scilab_en_US_help/jhelpmap.jhm3
-rw-r--r--help/en_US/scilab_en_US_help/jhelptoc.xml3
-rw-r--r--help/en_US/xcov1.xml64
12 files changed, 172 insertions, 1 deletions
diff --git a/help/en_US/cceps.xml b/help/en_US/cceps.xml
new file mode 100644
index 0000000..5c8779a
--- /dev/null
+++ b/help/en_US/cceps.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from cceps.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="cceps" 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>cceps</refname>
+ <refpurpose>Return the complex cepstrum of the vector x</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ cceps (x)
+ cceps(x, correct)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This function return the complex cepstrum of the vector x. If the optional argument correct has the value 1, a correction method is applied. The default is not to do this.
+</para>
+</refsection>
+</refentry>
diff --git a/help/en_US/master_help.xml b/help/en_US/master_help.xml
index 613d48a..b1dc7df 100644
--- a/help/en_US/master_help.xml
+++ b/help/en_US/master_help.xml
@@ -20,6 +20,7 @@
<!ENTITY ac9bfbd0f547b9f7951782fffc297ce8f SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/buffer.xml">
<!ENTITY a92ca529f2e4c50ecbb42fe6ac66b4ad7 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/butter.xml">
<!ENTITY aac95818ba66b9133270a9b65f48f4512 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/buttord.xml">
+<!ENTITY a90ab60d82d7a54f62db9da2aa96abb62 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/cceps.xml">
<!ENTITY acc531aceceaba9ba5f63feb980982703 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/cconv.xml">
<!ENTITY a9763f77681100b2386601412d6c68a45 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/cell2sos.xml">
<!ENTITY a2e5fe5c92463618e3ac3eb6184a6514c SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/cheb1ord.xml">
@@ -102,6 +103,7 @@
<!ENTITY a8b754f3c797b791b0773a17091b92d47 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/modulate.xml">
<!ENTITY a4409d7ece46667d2c6c236a19699a2db SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/morlet.xml">
<!ENTITY aae7674d788c35e75f2a52af92dc855bc SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/movingrms.xml">
+<!ENTITY ab4b637128ca75fb1cef24e3cba016008 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/mscohere.xml">
<!ENTITY a7022b9d1c7c194f27b1dd6bc4e093697 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/musicBase.xml">
<!ENTITY aef8e0226f6126afb2453e659221e7330 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/nnls.xml">
<!ENTITY aecbf6dfa1f6fa4c17585ac7e4eff69ef SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/nuttallwin.xml">
@@ -191,6 +193,7 @@
<!ENTITY ae56b79980853d5c39cda79745ad43e1c SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/wkeep.xml">
<!ENTITY afb072dbcb7e8025a801eb32f37a69dfb SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/wrev.xml">
<!ENTITY a9cce784055276e298cf721d8e269c31c SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/xcorr2.xml">
+<!ENTITY a4fefe2dc30b34efba778dabc938cfb1a SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/xcov1.xml">
<!ENTITY ad84d3dcc40317a06780d4e68cbec8db0 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/zerocrossing.xml">
<!ENTITY a522ad212c78230cdbad7a4a0d8daaadd SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/zp2sos.xml">
<!ENTITY ad0a91e7320d3da715c8e58990f5397a4 SYSTEM "/home/tushar/Documents/IITB/Toolbox/FOSSEE-Signal-Processing-Toolbox/help/en_US/zplane.xml">
@@ -229,6 +232,7 @@
&ac9bfbd0f547b9f7951782fffc297ce8f;
&a92ca529f2e4c50ecbb42fe6ac66b4ad7;
&aac95818ba66b9133270a9b65f48f4512;
+&a90ab60d82d7a54f62db9da2aa96abb62;
&acc531aceceaba9ba5f63feb980982703;
&a9763f77681100b2386601412d6c68a45;
&a2e5fe5c92463618e3ac3eb6184a6514c;
@@ -311,6 +315,7 @@
&a8b754f3c797b791b0773a17091b92d47;
&a4409d7ece46667d2c6c236a19699a2db;
&aae7674d788c35e75f2a52af92dc855bc;
+&ab4b637128ca75fb1cef24e3cba016008;
&a7022b9d1c7c194f27b1dd6bc4e093697;
&aef8e0226f6126afb2453e659221e7330;
&aecbf6dfa1f6fa4c17585ac7e4eff69ef;
@@ -400,6 +405,7 @@
&ae56b79980853d5c39cda79745ad43e1c;
&afb072dbcb7e8025a801eb32f37a69dfb;
&a9cce784055276e298cf721d8e269c31c;
+&a4fefe2dc30b34efba778dabc938cfb1a;
&ad84d3dcc40317a06780d4e68cbec8db0;
&a522ad212c78230cdbad7a4a0d8daaadd;
&ad0a91e7320d3da715c8e58990f5397a4;
diff --git a/help/en_US/mscohere.xml b/help/en_US/mscohere.xml
new file mode 100644
index 0000000..0b68767
--- /dev/null
+++ b/help/en_US/mscohere.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from mscohere.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="mscohere" 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>mscohere</refname>
+ <refpurpose>It estimate (mean square) coherence of signals x and y.</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ [Pxx, freq] = mscohere (x, y)
+ [Pxx, freq] = mscohere (x, y, window)
+ [Pxx, freq] = mscohere (x, y, window, overlap)
+ [Pxx, freq] = mscohere (x, y, window, overlap, Nfft)
+ [Pxx, freq] = mscohere (x, y, window, overlap, Nfft, Fs)
+ [Pxx, freq] = mscohere (x, y, window, overlap, Nfft, Fs, range)
+ mscohere (...)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This function estimate (mean square) coherence of signals x and y.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+[Pxx, freq] = mscohere(4,5)
+ans =
+PXX =
+Nan
+1
+FREQ =
+0
+0.5
+ ]]></programlisting>
+</refsection>
+</refentry>
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS
index 5a74719..8a34800 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS
Binary files differ
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB
index 053c5ec..96145ac 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB
Binary files differ
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS
index 2ec3c1b..e5dcf3e 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS
Binary files differ
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS
index 041305c..675b3b8 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS
Binary files differ
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA
index 677736a..67f95eb 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA
@@ -1,2 +1,2 @@
JavaSearch 1.0
-TMAP bs=2048 rt=1 fl=-1 id1=1967 id2=1
+TMAP bs=2048 rt=1 fl=-1 id1=1993 id2=1
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP
index 24e9f87..8001744 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP
Binary files differ
diff --git a/help/en_US/scilab_en_US_help/jhelpmap.jhm b/help/en_US/scilab_en_US_help/jhelpmap.jhm
index 61a8d3f..1843e44 100644
--- a/help/en_US/scilab_en_US_help/jhelpmap.jhm
+++ b/help/en_US/scilab_en_US_help/jhelpmap.jhm
@@ -22,6 +22,7 @@
<mapID target="buffer" url="buffer.html"/>
<mapID target="butter" url="butter.html"/>
<mapID target="buttord" url="buttord.html"/>
+<mapID target="cceps" url="cceps.html"/>
<mapID target="cconv" url="cconv.html"/>
<mapID target="cell2sos" url="cell2sos.html"/>
<mapID target="cheb1ord" url="cheb1ord.html"/>
@@ -104,6 +105,7 @@
<mapID target="modulate" url="modulate.html"/>
<mapID target="morlet" url="morlet.html"/>
<mapID target="movingrms" url="movingrms.html"/>
+<mapID target="mscohere" url="mscohere.html"/>
<mapID target="musicBase" url="musicBase.html"/>
<mapID target="nnls" url="nnls.html"/>
<mapID target="nuttallwin" url="nuttallwin.html"/>
@@ -193,6 +195,7 @@
<mapID target="wkeep" url="wkeep.html"/>
<mapID target="wrev" url="wrev.html"/>
<mapID target="xcorr2" url="xcorr2.html"/>
+<mapID target="xcov1" url="xcov1.html"/>
<mapID target="zerocrossing" url="zerocrossing.html"/>
<mapID target="zp2sos" url="zp2sos.html"/>
<mapID target="zplane" url="zplane.html"/>
diff --git a/help/en_US/scilab_en_US_help/jhelptoc.xml b/help/en_US/scilab_en_US_help/jhelptoc.xml
index 91a8471..ee5518c 100644
--- a/help/en_US/scilab_en_US_help/jhelptoc.xml
+++ b/help/en_US/scilab_en_US_help/jhelptoc.xml
@@ -22,6 +22,7 @@
<tocitem target="buffer" text="buffer"/>
<tocitem target="butter" text="butter"/>
<tocitem target="buttord" text="buttord"/>
+<tocitem target="cceps" text="cceps"/>
<tocitem target="cconv" text="cconv"/>
<tocitem target="cell2sos" text="cell2sos"/>
<tocitem target="cheb1ord" text="cheb1ord"/>
@@ -104,6 +105,7 @@
<tocitem target="modulate" text="modulate"/>
<tocitem target="morlet" text="morlet"/>
<tocitem target="movingrms" text="movingrms"/>
+<tocitem target="mscohere" text="mscohere"/>
<tocitem target="musicBase" text="musicBase"/>
<tocitem target="nnls" text="nnls"/>
<tocitem target="nuttallwin" text="nuttallwin"/>
@@ -193,6 +195,7 @@
<tocitem target="wkeep" text="wkeep"/>
<tocitem target="wrev" text="wrev"/>
<tocitem target="xcorr2" text="xcorr2"/>
+<tocitem target="xcov1" text="xcov1"/>
<tocitem target="zerocrossing" text="zerocrossing"/>
<tocitem target="zp2sos" text="zp2sos"/>
<tocitem target="zplane" text="zplane"/>
diff --git a/help/en_US/xcov1.xml b/help/en_US/xcov1.xml
new file mode 100644
index 0000000..3872563
--- /dev/null
+++ b/help/en_US/xcov1.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from xcov1.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="xcov1" 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>xcov1</refname>
+ <refpurpose>Compute covariance at various lags [=correlation(x-mean(x),y-mean(y))].</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ [R, lag] = xcov (X)
+ ... = xcov (X, Y)
+ ... = xcov (..., maxlag)
+ ... = xcov (..., scale)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>X:</term>
+ <listitem><para> Input vector</para></listitem></varlistentry>
+ <varlistentry><term>Y:</term>
+ <listitem><para> if specified, compute cross-covariance between X and Y, otherwise compute autocovariance of X.</para></listitem></varlistentry>
+ <varlistentry><term>maxlag:</term>
+ <listitem><para> is specified, use lag range [-maxlag:maxlag], otherwise use range [-n+1:n-1].</para></listitem></varlistentry>
+ <varlistentry><term>scale:</term>
+ <listitem><para> </para></listitem></varlistentry>
+ <varlistentry><term>'biased':</term>
+ <listitem><para> for covariance=raw/N,</para></listitem></varlistentry>
+ <varlistentry><term>'unbiased':</term>
+ <listitem><para> for covariance=raw/(N-|lag|),</para></listitem></varlistentry>
+ <varlistentry><term>'coeff':</term>
+ <listitem><para> for covariance=raw/(covariance at lag 0),</para></listitem></varlistentry>
+ <varlistentry><term>'none':</term>
+ <listitem><para> for covariance=raw</para></listitem></varlistentry>
+ <varlistentry><term>'none':</term>
+ <listitem><para> is the default.</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+Compute covariance at various lags [=correlation(x-mean(x),y-mean(y))]. Returns the covariance for each lag in the range, plus an optional vector of lags.
+</para>
+</refsection>
+</refentry>
generated by cgit (git 2.34.1) at 2024-12-20 09:58:48 +0000