diff options
73 files changed, 2744 insertions, 17 deletions
@@ -1,2 +1,13 @@ # FOSSEE-Signal-Processing-Toolbox -Scilab toolbox for signal processing and digital signal processing +Scilab toolbox for signal processing and digital signal processing. + +## Dependencies +Scilab-octave interface : http://scilab.in/scilab_toolbox/download_codes/FOSSEE_Scilab_Octave_Interface_Toolbox.tar.gz + +## How to use +1. Download and extract the dependancy listed above and put it in a location of your choice. +2. Clone this repo as it is and put it in the same folder as the dependancy folder. +3. Go to scilab-octave interface folder, execute the loader.sce using `exec loader.sce`. +4. Go to the signal processing folder, execute the builder.sce using `exec builder.sce`. +5. Execute loader.sce using `exec loader.sce` and start using the functions in the toolbox. +6. Steps 3,4,5 should be repeated everytime you restart the scilab to load everything again. diff --git a/help/en_US/ac2rc.xml b/help/en_US/ac2rc.xml index 2e8a109..a84b240 100644 --- a/help/en_US/ac2rc.xml +++ b/help/en_US/ac2rc.xml @@ -17,7 +17,7 @@ <refnamediv> <refname>ac2rc</refname> - <refpurpose></refpurpose> + <refpurpose>Convert autocorrelation sequence to reflection coefficients.</refpurpose> </refnamediv> @@ -26,6 +26,33 @@ <synopsis> k = ac2rc(R) [k,R0] = ac2rc(R) + </synopsis> </refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>R:</term> + <listitem><para> The input autocorrelation sequence. If r is a matrix, each column of r is treated as a separate signal.</para></listitem></varlistentry> + <varlistentry><term>k:</term> + <listitem><para> Returns the reflection coefficients</para></listitem></varlistentry> + <varlistentry><term>R0:</term> + <listitem><para> the zero lag autocorrelation, R0, based on the autocorrelation sequence, R.</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +X = [7 6 5 8 3 6 8 7 5 2 4 7 4 3 2 5 4 9 5 3 5 7 3 9 4 1 2 0 5 4 8 6 4 6 5 3]; +[k,R0] = ac2rc(X) +or t=[2 5 6; 8 6 5; 8 9 4] +[k,R0] = ac2rc(t) + +Author +Jitendra Singh + + ]]></programlisting> +</refsection> </refentry> diff --git a/help/en_US/arburg.xml b/help/en_US/arburg.xml index 75648ba..6aa017e 100644 --- a/help/en_US/arburg.xml +++ b/help/en_US/arburg.xml @@ -49,7 +49,11 @@ <title>Description</title> <para> This is an Octave function. + </para> + <para> This function calculates coefficients of an autoregressive (AR) model of complex data x using the whitening lattice-filter method of Burg. + </para> + <para> The first argument is the data sampled. The second argument is the number of poles in the model (or limit in case a criterion is supplied). The third parameter takes in the criterion to limit the number of poles. The acceptable values are "AIC", "AKICc", "KIC", "AICc" which are based on information theory. Output variable a is a list of P+1 autoregression coefficients. diff --git a/help/en_US/arcov.xml b/help/en_US/arcov.xml index 64a5364..11f1d94 100644 --- a/help/en_US/arcov.xml +++ b/help/en_US/arcov.xml @@ -17,7 +17,29 @@ <refnamediv> <refname>arcov</refname> - <refpurpose></refpurpose> + <refpurpose>Autoregressive all-pole model parameters — covariance method</refpurpose> </refnamediv> + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + a = arcov(x,p) + [a,e] = arcov(x,p) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>a:</term> + <listitem><para> contains normalized estimates of the AR system parameters, A(z), in descending powers of z.</para></listitem></varlistentry> + <varlistentry><term>e:</term> + <listitem><para> variance estimate of the white noise input to the AR model</para></listitem></varlistentry> + <varlistentry><term>x:</term> + <listitem><para> is the input signal</para></listitem></varlistentry> + <varlistentry><term>p:</term> + <listitem><para> is the order of the auto regressive model</para></listitem></varlistentry> + </variablelist> +</refsection> </refentry> diff --git a/help/en_US/aryule.xml b/help/en_US/aryule.xml index 9948a0f..7d706fd 100644 --- a/help/en_US/aryule.xml +++ b/help/en_US/aryule.xml @@ -46,6 +46,8 @@ <title>Description</title> <para> This is an Octave function. + </para> + <para> This function fits an AR (p)-model with Yule-Walker estimates. The first argument is the data vector which is to be estimated. Output variable a gives the AR coefficients, v gives the variance of the white noise and k gives the reflection coefficients to be used in the lattice filter. diff --git a/help/en_US/besselap.xml b/help/en_US/besselap.xml new file mode 100644 index 0000000..f3236d7 --- /dev/null +++ b/help/en_US/besselap.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from besselap.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="besselap" 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>besselap</refname> + <refpurpose>Return bessel analog filter prototype.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [zero, pole, gain] = besselap (n) + [zero, pole] = besselap (n) + zero = besselap (n) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> Filter Order</para></listitem></varlistentry> + <varlistentry><term>zero:</term> + <listitem><para> Zeros</para></listitem></varlistentry> + <varlistentry><term>pole:</term> + <listitem><para> Poles</para></listitem></varlistentry> + <varlistentry><term>gain:</term> + <listitem><para> Gain</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It Return bessel analog filter prototype of nth order. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[zero, pole, gain] = besselap (5) +zero = [](0x0) +pole = + +-0.59058 + 0.90721i +-0.59058 - 0.90721i +-0.92644 + 0.00000i +-0.85155 + 0.44272i +-0.85155 - 0.44272i + +gain = 1 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/buttap.xml b/help/en_US/buttap.xml new file mode 100644 index 0000000..d891af5 --- /dev/null +++ b/help/en_US/buttap.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from buttap.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="buttap" 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>buttap</refname> + <refpurpose>Design a lowpass analog Butterworth filter.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + z = buttap (n) + [z, p] = buttap (n) + [z, p, g] = buttap (n) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> Filter Order</para></listitem></varlistentry> + <varlistentry><term>z:</term> + <listitem><para> Zeros</para></listitem></varlistentry> + <varlistentry><term>p:</term> + <listitem><para> Poles</para></listitem></varlistentry> + <varlistentry><term>g:</term> + <listitem><para> Gain</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It designs a lowpass analog Butterworth filter of nth order. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[z, p, g] = buttap (5) +z = [](0x0) +p = + +-0.30902 + 0.95106i -0.80902 + 0.58779i -1.00000 + 0.00000i -0.80902 - 0.58779i -0.30902 - 0.95106i + +g = 1 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/cheb.xml b/help/en_US/cheb.xml new file mode 100644 index 0000000..7e39e30 --- /dev/null +++ b/help/en_US/cheb.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from cheb.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="cheb" 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>cheb</refname> + <refpurpose>Calculates the nth-order Chebyshev polynomial at the point x.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + cheb(n, x) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> Filter order</para></listitem></varlistentry> + <varlistentry><term>x:</term> + <listitem><para> Point at which the Chebyshev polynomial is calculater.</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +Equation for Chebyshev polynomial is +/ cos(n acos(x), |x| <= 1 +Tn(x) = | +\ cosh(n acosh(x), |x| > 1 + </para> + <para> +x can also be a vector. In that case the output will also be a vector of same size as x. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = [1 2 3 4] +cheb(10, x) +ans = + +1.0000e+00 2.6209e+05 2.2620e+07 4.5747e+08 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/cheb1ap.xml b/help/en_US/cheb1ap.xml new file mode 100644 index 0000000..dbd541a --- /dev/null +++ b/help/en_US/cheb1ap.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from cheb1ap.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="cheb1ap" 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>cheb1ap</refname> + <refpurpose>This function designs a lowpass analog Chebyshev type I filter.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [z, p, g] = cheb1ap (n, Rp) + [z, p] = cheb1ap (n, Rp) + p = cheb1ap (n, Rp) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> Filter Order</para></listitem></varlistentry> + <varlistentry><term>Rp:</term> + <listitem><para> Peak-to-peak passband ripple</para></listitem></varlistentry> + <varlistentry><term>z:</term> + <listitem><para> Zeros</para></listitem></varlistentry> + <varlistentry><term>p:</term> + <listitem><para> Poles</para></listitem></varlistentry> + <varlistentry><term>g:</term> + <listitem><para> Gain</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It designs a lowpass analog Chebyshev type I filter of nth order and with a Peak-to-peak passband ripple of Rp. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[z, p, g] = cheb1ap (10, 20) +z = [](0x0) +p = + +Columns 1 through 6: + +-0.00157 - 0.98774i -0.00456 - 0.89105i -0.00709 - 0.70714i -0.00894 - 0.45401i -0.00991 - 0.15644i -0.00991 + 0.15644i + +Columns 7 through 10: + +-0.00894 + 0.45401i -0.00709 + 0.70714i -0.00456 + 0.89105i -0.00157 + 0.98774i + +g = 1.9630e-04 - 6.3527e-22i + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/cheb2ap.xml b/help/en_US/cheb2ap.xml new file mode 100644 index 0000000..0fcdd8f --- /dev/null +++ b/help/en_US/cheb2ap.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from cheb2ap.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="cheb2ap" 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>cheb2ap</refname> + <refpurpose>This function designs a lowpass analog Chebyshev type II filter.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [z, p, g] = cheb2ap (n, Rs) + [z, p] = cheb2ap (n, Rs) + p = cheb2ap (n, Rs) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> Filter Order</para></listitem></varlistentry> + <varlistentry><term>Rs:</term> + <listitem><para> Stopband attenuation</para></listitem></varlistentry> + <varlistentry><term>z:</term> + <listitem><para> Zeros</para></listitem></varlistentry> + <varlistentry><term>p:</term> + <listitem><para> Poles</para></listitem></varlistentry> + <varlistentry><term>g:</term> + <listitem><para> Gain</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +This function designs a lowpass analog Chebyshev type II filter of nth order and with a stopband attenuation of Rs. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/cplxreal.xml b/help/en_US/cplxreal.xml new file mode 100644 index 0000000..f5e5ed5 --- /dev/null +++ b/help/en_US/cplxreal.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from cplxreal.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="cplxreal" 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>cplxreal</refname> + <refpurpose>Function to divide vector z into complex and real elements, removing the one of each complex conjugate pair.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [zc, zr] = cplxreal (z, thresh) + [zc, zr] = cplxreal (z) + zc = cplxreal (z, thresh) + zc = cplxreal (z) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>z:</term> + <listitem><para> vector of complex numbers.</para></listitem></varlistentry> + <varlistentry><term>thresh:</term> + <listitem><para> tolerance for comparisons.</para></listitem></varlistentry> + <varlistentry><term>zc:</term> + <listitem><para> vector containing the elements of z that have positive imaginary parts.</para></listitem></varlistentry> + <varlistentry><term>zr:</term> + <listitem><para> vector containing the elements of z that are real.</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +Every complex element of z is expected to have a complex-conjugate elsewhere in z. From the pair of complex-conjugates, the one with the negative imaginary part is removed. +If the magnitude of the imaginary part of an element is less than the thresh, it is declared as real. +</para> +</refsection> +</refentry> diff --git a/help/en_US/czt.xml b/help/en_US/czt.xml new file mode 100644 index 0000000..1296d19 --- /dev/null +++ b/help/en_US/czt.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from czt.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="czt" 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>czt</refname> + <refpurpose>Chirp Z Transform</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + czt (x) + czt (x, m) + czt (x, m, w) + czt (x, m, w, a) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> Input scalar or vector</para></listitem></varlistentry> + <varlistentry><term>m:</term> + <listitem><para> Total Number of steps</para></listitem></varlistentry> + <varlistentry><term>w:</term> + <listitem><para> ratio between points in each step</para></listitem></varlistentry> + <varlistentry><term>a:</term> + <listitem><para> point in the complex plane</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +Chirp z-transform. Compute the frequency response starting at a and stepping by w for m steps. a is a point in the complex plane, and w is the ratio between points in each step (i.e., radius increases exponentially, and angle increases linearly). +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +m = 32; ## number of points desired +w = exp(-j*2*pi*(f2-f1)/((m-1)*Fs)); ## freq. step of f2-f1/m +a = exp(j*2*pi*f1/Fs); ## starting at frequency f1 +y = czt(x, m, w, a); + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/dst1.xml b/help/en_US/dst1.xml new file mode 100644 index 0000000..62fa699 --- /dev/null +++ b/help/en_US/dst1.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from dst1.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="dst1" 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>dst1</refname> + <refpurpose>Computes the type I discrete sine transform of x</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + y= dst1(x) + y= dst1(x,n) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> real or complex valued vector</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +Computes the type I discrete sine transform of x. If n is given, then x is padded or trimmed to length n before computing the transform. If x is a matrix, compute the transform along the columns of the the matrix. +</para> +</refsection> +</refentry> diff --git a/help/en_US/ellipap.xml b/help/en_US/ellipap.xml new file mode 100644 index 0000000..597a4c1 --- /dev/null +++ b/help/en_US/ellipap.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from ellipap.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="ellipap" 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>ellipap</refname> + <refpurpose>Designs a lowpass analog elliptic filter.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [z, p, g] = ellipap (n, Rp, Rs) + [z, p] = ellipap (n, Rp, Rs) + z = ellipap (n, Rp, Rs) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> Filter Order</para></listitem></varlistentry> + <varlistentry><term>Rp:</term> + <listitem><para> Peak-to-peak passband ripple</para></listitem></varlistentry> + <varlistentry><term>Rs:</term> + <listitem><para> Stopband attenuation</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It designs a lowpass analog elliptic filter of nth order, with a Peak-to-peak passband ripple of Rp and a stopband attenuation of Rs. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[z, p, g] = ellipap (5, 10, 10) +z = + +0.0000 + 2.5546i 0.0000 + 1.6835i -0.0000 - 2.5546i -0.0000 - 1.6835i + +p = + +-0.05243 + 0.63524i -0.01633 + 0.96289i -0.05243 - 0.63524i -0.01633 - 0.96289i -0.07369 + 0.00000i + +g = 0.0015012 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/fft.xml b/help/en_US/fft.xml new file mode 100644 index 0000000..12922ed --- /dev/null +++ b/help/en_US/fft.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from fft.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="fft" 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>fft</refname> + <refpurpose>Calculates the discrete Fourier transform of a matrix using Fast Fourier Transform algorithm.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + fft (x, n, dim) + fft (x, n) + fft (x) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> input matrix</para></listitem></varlistentry> + <varlistentry><term>n:</term> + <listitem><para> Specifies the number of elements of x to be used</para></listitem></varlistentry> + <varlistentry><term>dim:</term> + <listitem><para> Specifies the dimention of the matrix along which the FFT is performed</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +The FFT is calculated along the first non-singleton dimension of the array. Thus, FFT is computed for each column of x. + </para> + <para> +n is an integer specifying the number of elements of x to use. If n is larger than dimention along. which the FFT is calculated, then x is resized and padded with zeros. +Similarly, if n is smaller, then x is truncated. + </para> + <para> +dim is an integer specifying the dimension of the matrix along which the FFT is performed. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = [1 2 3; 4 5 6; 7 8 9] +n = 3 +dim = 2 +fft (x, n, dim) +ans = + +6.0000 + 0.0000i -1.5000 + 0.8660i -1.5000 - 0.8660i +15.0000 + 0.0000i -1.5000 + 0.8660i -1.5000 - 0.8660i +24.0000 + 0.0000i -1.5000 + 0.8660i -1.5000 - 0.8660i + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/fft2.xml b/help/en_US/fft2.xml new file mode 100644 index 0000000..d35fc4a --- /dev/null +++ b/help/en_US/fft2.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from fft2.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="fft2" 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>fft2</refname> + <refpurpose>Calculates the two-dimensional discrete Fourier transform of A using a Fast Fourier Transform algorithm.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + fft2 (A, m, n) + fft2 (A) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>A:</term> + <listitem><para> input matrix</para></listitem></varlistentry> + <varlistentry><term>m:</term> + <listitem><para> number of rows of A to be used</para></listitem></varlistentry> + <varlistentry><term>n:</term> + <listitem><para> number of columns of A to be used</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It performs two-dimentional FFT on the matrix A. m and n may be used specify the number of rows and columns of A to use. If either of these is larger than the size of A, A is resized and padded with zeros. +If A is a multi-dimensional matrix, each two-dimensional sub-matrix of A is treated separately. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = [1 2 3; 4 5 6; 7 8 9] +m = 4 +n = 4 +fft2 (A, m, n) +ans = + +45 + 0i -6 - 15i 15 + 0i -6 + 15i +-18 - 15i -5 + 8i -6 - 5i 5 - 4i +15 + 0i -2 - 5i 5 + 0i -2 + 5i +-18 + 15i 5 + 4i -6 + 5i -5 - 8i + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/fht.xml b/help/en_US/fht.xml new file mode 100644 index 0000000..06311a3 --- /dev/null +++ b/help/en_US/fht.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from fht.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="fht" 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>fht</refname> + <refpurpose>funcprot(0);</refpurpose> + </refnamediv> + +</refentry> diff --git a/help/en_US/freqs.xml b/help/en_US/freqs.xml new file mode 100644 index 0000000..258f280 --- /dev/null +++ b/help/en_US/freqs.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from freqs.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="freqs" 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>freqs</refname> + <refpurpose>Compute the s-plane frequency response of the IIR filter.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h = freqs (b, a, w) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>b:</term> + <listitem><para> vector containing the coefficients of the numerator of the filter.</para></listitem></varlistentry> + <varlistentry><term>a:</term> + <listitem><para> vector containing the coefficients of the denominator of the filter.</para></listitem></varlistentry> + <varlistentry><term>w:</term> + <listitem><para> vector containing frequencies</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It computes the s-plane frequency response of the IIR filter B(s)/A(s) as H = polyval(B,j*W)./polyval(A,j*W). +If called with no output argument, a plot of magnitude and phase are displayed. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +B = [1 2]; +A = [1 1]; +w = linspace(0,4,128); +freqs(B,A,w); + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/fwht.xml b/help/en_US/fwht.xml new file mode 100644 index 0000000..4140453 --- /dev/null +++ b/help/en_US/fwht.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from fwht.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="fwht" 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>fwht</refname> + <refpurpose>Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + fwht (x) + fwht (x, n) + fwht (x, n, order) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> real or complex valued scalar or vector</para></listitem></varlistentry> + <varlistentry><term>n:</term> + <listitem><para> x is truncated or extended to have length n</para></listitem></varlistentry> + <varlistentry><term>order:</term> + <listitem><para> Specification of order in which coefficients should be arranged</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm. If the input is a matrix, the FWHT is calculated along the columns of x. + </para> + <para> +The number of elements of x must be a power of 2; if not, the input will be extended and filled with zeros. If a second argument is given, the input is truncated or extended to have length n. + </para> + <para> +The third argument specifies the order in which the returned Walsh-Hadamard transform coefficients should be arranged. The order may be any of the following strings: + </para> + <para> +"sequency" +The coefficients are returned in sequency order. This is the default if order is not given. + </para> + <para> +"hadamard" +The coefficients are returned in Hadamard order. + </para> + <para> +"dyadic" +The coefficients are returned in Gray code order. +</para> +</refsection> +</refentry> diff --git a/help/en_US/hanning.xml b/help/en_US/hanning.xml new file mode 100644 index 0000000..dc1e475 --- /dev/null +++ b/help/en_US/hanning.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from hanning.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="hanning" 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>hanning</refname> + <refpurpose></refpurpose> + </refnamediv> + +</refentry> diff --git a/help/en_US/hilbert1.xml b/help/en_US/hilbert1.xml new file mode 100644 index 0000000..3d4ab42 --- /dev/null +++ b/help/en_US/hilbert1.xml @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from hilbert1.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="hilbert1" 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>hilbert1</refname> + <refpurpose>Analytic extension of real valued signal.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + h= hilbert1(f) + h= hilbert1(f,N) + h= hilbert1(f,N,dim) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>f:</term> + <listitem><para> real or complex valued scalar or vector</para></listitem></varlistentry> + <varlistentry><term>N:</term> + <listitem><para> The result will have length N</para></listitem></varlistentry> + <varlistentry><term>dim :</term> + <listitem><para> It analyses the input in this dimension</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +h = hilbert (f) computes the extension of the real valued signal f to an analytic signal. If f is a matrix, the transformation is applied to each column. For N-D arrays, the transformation is applied to the first non-singleton dimension. + </para> + <para> +real (h) contains the original signal f. imag (h) contains the Hilbert transform of f. + </para> + <para> +hilbert1 (f, N) does the same using a length N Hilbert transform. The result will also have length N. + </para> + <para> +hilbert1 (f, [], dim) or hilbert1 (f, N, dim) does the same along dimension dim. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +## notice that the imaginary signal is phase-shifted 90 degrees +t=linspace(0,10,256); +z = hilbert1(sin(2*pi*0.5*t)); +grid on; plot(t,real(z),';real;',t,imag(z),';imag;'); + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/hurst.xml b/help/en_US/hurst.xml new file mode 100644 index 0000000..c6c5f3e --- /dev/null +++ b/help/en_US/hurst.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from hurst.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="hurst" 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>hurst</refname> + <refpurpose>Estimate the Hurst parameter of sample X via the rescaled r statistic.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + hurst(X) + variable=hurst(X) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X:</term> + <listitem><para> X is a matrix, the parameter of sample X via the rescaled r statistic</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +This function estimates the Hurst parameter of sample X via the rescaled rstatistic. +</para> +</refsection> +</refentry> diff --git a/help/en_US/idct1.xml b/help/en_US/idct1.xml new file mode 100644 index 0000000..c43eb1c --- /dev/null +++ b/help/en_US/idct1.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from idct1.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="idct1" 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>idct1</refname> + <refpurpose>funcprot(0);</refpurpose> + </refnamediv> + +</refentry> diff --git a/help/en_US/idct2.xml b/help/en_US/idct2.xml new file mode 100644 index 0000000..0e7fcdc --- /dev/null +++ b/help/en_US/idct2.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from idct2.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="idct2" 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>idct2</refname> + <refpurpose>funcprot(0);</refpurpose> + </refnamediv> + +</refentry> diff --git a/help/en_US/idst1.xml b/help/en_US/idst1.xml new file mode 100644 index 0000000..74a9f0e --- /dev/null +++ b/help/en_US/idst1.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from idst1.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="idst1" 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>idst1</refname> + <refpurpose>funcprot(0);</refpurpose> + </refnamediv> + +</refentry> diff --git a/help/en_US/ifft.xml b/help/en_US/ifft.xml new file mode 100644 index 0000000..5e09726 --- /dev/null +++ b/help/en_US/ifft.xml @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from ifft.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="ifft" 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>ifft</refname> + <refpurpose>Calculates the inverse discrete Fourier transform of a matrix using Fast Fourier Transform algorithm.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + ifft (x, n, dim) + ifft (x, n) + ifft (x) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> input matrix</para></listitem></varlistentry> + <varlistentry><term>n:</term> + <listitem><para> Specifies the number of elements of x to be used</para></listitem></varlistentry> + <varlistentry><term>dim:</term> + <listitem><para> Specifies the dimention of the matrix along which the inverse FFT is performed</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +</para> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +The inverse FFT is calculated along the first non-singleton dimension of the array. Thus, inverse FFT is computed for each column of x. + </para> + <para> +n is an integer specifying the number of elements of x to use. If n is larger than dimention along. which the inverse FFT is calculated, then x is resized and padded with zeros. +Similarly, if n is smaller, then x is truncated. + </para> + <para> +dim is an integer specifying the dimension of the matrix along which the inverse FFT is performed. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = [1 2 3; 4 5 6; 7 8 9] +n = 3 +dim = 2 +ifft (x, n, dim) +ans = + +2.00000 + 0.00000i -0.50000 - 0.28868i -0.50000 + 0.28868i +5.00000 + 0.00000i -0.50000 - 0.28868i -0.50000 + 0.28868i +8.00000 + 0.00000i -0.50000 - 0.28868i -0.50000 + 0.28868i + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/ifft2.xml b/help/en_US/ifft2.xml new file mode 100644 index 0000000..02eb5f9 --- /dev/null +++ b/help/en_US/ifft2.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from ifft2.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="ifft2" 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>ifft2</refname> + <refpurpose>Calculates the inverse two-dimensional discrete Fourier transform of A using a Fast Fourier Transform algorithm.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + ifft2 (A, m, n) + ifft2 (A) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>A:</term> + <listitem><para> input matrix</para></listitem></varlistentry> + <varlistentry><term>m:</term> + <listitem><para> number of rows of A to be used</para></listitem></varlistentry> + <varlistentry><term>n:</term> + <listitem><para> number of columns of A to be used</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It performs inverse two-dimensional FFT on the matrix A. m and n may be used specify the number of rows and columns of A to use. If either of these is larger than the size of A, A is resized and padded with zeros. +If A is a multi-dimensional matrix, each two-dimensional sub-matrix of A is treated separately. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +x = [1 2 3; 4 5 6; 7 8 9] +m = 4 +n = 4 +ifft2 (A, m, n) +ans = + +2.81250 + 0.00000i -0.37500 + 0.93750i 0.93750 + 0.00000i -0.37500 - 0.93750i +-1.12500 + 0.93750i -0.31250 - 0.50000i -0.37500 + 0.31250i 0.31250 + 0.25000i +0.93750 + 0.00000i -0.12500 + 0.31250i 0.31250 + 0.00000i -0.12500 - 0.31250i +-1.12500 - 0.93750i 0.31250 - 0.25000i -0.37500 - 0.31250i -0.31250 + 0.50000i + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/ifht.xml b/help/en_US/ifht.xml new file mode 100644 index 0000000..e4e692b --- /dev/null +++ b/help/en_US/ifht.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from ifht.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="ifht" 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>ifht</refname> + <refpurpose>Calculate the inverse Fast Hartley Transform of real input D</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + m= ifht (d) + m= ifht (d,n) + m= ifht (d,n,dim) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>d:</term> + <listitem><para> real or complex valued scalar or vector</para></listitem></varlistentry> + <varlistentry><term>n:</term> + <listitem><para> Similar to the options of FFT function</para></listitem></varlistentry> + <varlistentry><term>dim:</term> + <listitem><para> Similar to the options of FFT function</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Calculate the inverse Fast Hartley Transform of real input d. If d is a matrix, the inverse Hartley transform is calculated along the columns by default. The options n and dim are similar to the options of FFT function. + </para> + <para> +The forward and inverse Hartley transforms are the same (except for a scale factor of 1/N for the inverse hartley transform), but implemented using different functions. + </para> + <para> +The definition of the forward hartley transform for vector d, m[K] = 1/N \sum_{i=0}^{N-1} d[i]*(cos[K*2*pi*i/N] + sin[K*2*pi*i/N]), for 0 <= K < N. m[K] = 1/N \sum_{i=0}^{N-1} d[i]*CAS[K*i], for 0 <= K < N. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +ifht(1 : 4) +ifht(1:4, 2) + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/ifwht.xml b/help/en_US/ifwht.xml new file mode 100644 index 0000000..37903a0 --- /dev/null +++ b/help/en_US/ifwht.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from ifwht.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="ifwht" 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>ifwht</refname> + <refpurpose></refpurpose> + </refnamediv> + +</refentry> diff --git a/help/en_US/invfreq.xml b/help/en_US/invfreq.xml new file mode 100644 index 0000000..38f2da3 --- /dev/null +++ b/help/en_US/invfreq.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from invfreq.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="invfreq" 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>invfreq</refname> + <refpurpose>Calculates inverse frequency vectors</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [B,A] = invfreq(H,F,nB,nA) + [B,A] = invfreq(H,F,nB,nA,W) + [B,A] = invfreq(H,F,nB,nA,W,[],[],plane) + [B,A] = invfreq(H,F,nB,nA,W,iter,tol,plane) + + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>H:</term> + <listitem><para> desired complex frequency response,It is assumed that A and B are real polynomials, hence H is one-sided.</para></listitem></varlistentry> + <varlistentry><term>F:</term> + <listitem><para> vector of frequency samples in radians</para></listitem></varlistentry> + <varlistentry><term>nA:</term> + <listitem><para> order of denominator polynomial A</para></listitem></varlistentry> + <varlistentry><term>nB:</term> + <listitem><para> order of numerator polynomial B</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Fit filter B(z)/A(z) or B(s)/A(s) to complex frequency response at frequency points F. A and B are real polynomial coefficients of order nA and nB respectively. Optionally, the fit-errors can be weighted vs frequency according to the weights W. Also, the transform plane can be specified as either 's' for continuous time or 'z' for discrete time. 'z' is chosen by default. Eventually, Steiglitz-McBride iterations will be specified by iter and tol. + </para> + <para> +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +[B,A] = butter(12,1/4); +[H,w] = freqz(B,A,128); +[Bh,Ah] = invfreq(H,F,4,4); +Hh = freqz(Bh,Ah); +disp(sprintf('||frequency response error|| = %f',norm(H-Hh))); + + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/ncauer.xml b/help/en_US/ncauer.xml new file mode 100644 index 0000000..a9395af --- /dev/null +++ b/help/en_US/ncauer.xml @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from ncauer.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="ncauer" 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>ncauer</refname> + <refpurpose>Analog prototype for Cauer filter.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [Zz, Zp, Zg] = ncauer(Rp, Rs, n) + [Zz, Zp] = ncauer(Rp, Rs, n) + Zz = ncauer(Rp, Rs, n) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> Filter Order</para></listitem></varlistentry> + <varlistentry><term>Rp:</term> + <listitem><para> Peak-to-peak passband ripple</para></listitem></varlistentry> + <varlistentry><term>Rs:</term> + <listitem><para> Stopband attenuation</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It designs an analog prototype for Cauer filter of nth order, with a Peak-to-peak passband ripple of Rp and a stopband attenuation of Rs. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +n = 5; +Rp = 5; +Rs = 5; +[Zz, Zp, Zg] = ncauer(Rp, Rs, n) +Zz = + +0.0000 + 2.5546i 0.0000 + 1.6835i -0.0000 - 2.5546i -0.0000 - 1.6835i + +Zp = + +-0.10199 + 0.64039i -0.03168 + 0.96777i -0.10199 - 0.64039i -0.03168 - 0.96777i -0.14368 + 0.00000i + +Zg = 0.0030628 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/pei_tseng_notch.xml b/help/en_US/pei_tseng_notch.xml new file mode 100644 index 0000000..a2b1f37 --- /dev/null +++ b/help/en_US/pei_tseng_notch.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from pei_tseng_notch.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="pei_tseng_notch" 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>pei_tseng_notch</refname> + <refpurpose></refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [b, a] = pei_tseng_notch (frequencies, bandwidths) + b = pei_tseng_notch (frequencies, bandwidths) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>frequencies:</term> + <listitem><para> filter frequencies</para></listitem></varlistentry> + <varlistentry><term>bandwidths:</term> + <listitem><para> bandwidths to be used with filter</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It return coefficients for an IIR notch-filter with one or more filter frequencies and according bandwidths. The filter is based on a all pass filter that performs phasereversal at filter frequencies. +This leads to removal of those frequencies of the original and phase-distorted signal. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +sf = 800; sf2 = sf/2; +data=[[1;zeros(sf-1,1)],sinetone(49,sf,1,1),sinetone(50,sf,1,1),sinetone(51,sf,1,1)]; +[b,a]=pei_tseng_notch ( 50 / sf2, 2/sf2 ) +b = + +0.99213 -1.83322 0.99213 + +a = + +1.00000 -1.83322 0.98426 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/rceps.xml b/help/en_US/rceps.xml new file mode 100644 index 0000000..fbf1ce8 --- /dev/null +++ b/help/en_US/rceps.xml @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from rceps.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="rceps" 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>rceps</refname> + <refpurpose>Produce the cepstrum of the signal x, and if desired, the minimum phase reconstruction of the signal x.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [y, xm] = rceps(x) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> real or complex vector input</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +f0 = 70; Fs = 10000; # 100 Hz fundamental, 10kHz sampling rate +a = poly (0.985 * exp (1i*pi*[0.1, -0.1, 0.3, -0.3])); # two formants +s = 0.005 * randn (1024, 1); # Noise excitation signal +s(1:Fs/f0:length(s)) = 1; # Impulse glottal wave +x = filter (1, a, s); # Speech signal in x +[y, xm] = rceps (x .* hanning (1024)); # cepstrum and min phase reconstruction + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/remez1.xml b/help/en_US/remez1.xml new file mode 100644 index 0000000..0336490 --- /dev/null +++ b/help/en_US/remez1.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from remez1.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="remez1" 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>remez1</refname> + <refpurpose>Parks-McClellan optimal FIR filter design</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + b = remez1 (n, f, a) + b = remez1 (n, f, a, w) + b = remez1 (n, f, a, w, ftype) + b = remez1 (n, f, a, w, ftype, griddensity) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>n:</term> + <listitem><para> gives the number of taps in the returned filter</para></listitem></varlistentry> + <varlistentry><term>f:</term> + <listitem><para>gives frequency at the band edges [b1 e1 b2 e2 b3 e3 …]</para></listitem></varlistentry> + <varlistentry><term>a:</term> + <listitem><para>gives amplitude at the band edges [a(b1) a(e1) a(b2) a(e2) …]</para></listitem></varlistentry> + <varlistentry><term>w:</term> + <listitem><para>gives weighting applied to each band</para></listitem></varlistentry> + <varlistentry><term>ftype:</term> + <listitem><para>is "bandpass", "hilbert" or "differentiator"</para></listitem></varlistentry> + <varlistentry><term>griddensity:</term> + <listitem><para>determines how accurately the filter will be constructed. The minimum value is 16, but higher numbers are slower to compute.</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Frequency is in the range (0, 1), with 1 being the Nyquist frequency. +</para> +</refsection> +</refentry> diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS Binary files differindex 8a34800..2edc88b 100644 --- a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB Binary files differindex 96145ac..72fff7e 100644 --- a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS Binary files differindex e5dcf3e..a1945f0 100644 --- a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS Binary files differindex 675b3b8..0f05c07 100644 --- a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA index 67f95eb..677736a 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=1993 id2=1 +TMAP bs=2048 rt=1 fl=-1 id1=1967 id2=1 diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP Binary files differindex 8001744..067ca95 100644 --- a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP diff --git a/help/en_US/scilab_en_US_help/jhelpmap.jhm b/help/en_US/scilab_en_US_help/jhelpmap.jhm index 1843e44..add47c8 100644 --- a/help/en_US/scilab_en_US_help/jhelpmap.jhm +++ b/help/en_US/scilab_en_US_help/jhelpmap.jhm @@ -2,7 +2,7 @@ <!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN" "http://java.sun.com/products/javahelp/map_1_0.dtd"> <map version="1.0"> <mapID target="index" url="index.html"/> -<mapID target="section_cc2bc01c47967d47fcf3507a91d572ba" url="section_cc2bc01c47967d47fcf3507a91d572ba.html"/> +<mapID target="section_5118e822ecc2888aa80042108de4932e" url="section_5118e822ecc2888aa80042108de4932e.html"/> <mapID target="ac2poly" url="ac2poly.html"/> <mapID target="ac2rc" url="ac2rc.html"/> <mapID target="arParEst" url="arParEst.html"/> @@ -12,6 +12,7 @@ <mapID target="aryule" url="aryule.html"/> <mapID target="barthannwin" url="barthannwin.html"/> <mapID target="bartlett" url="bartlett.html"/> +<mapID target="besselap" url="besselap.html"/> <mapID target="besself" url="besself.html"/> <mapID target="bitrevorder" url="bitrevorder.html"/> <mapID target="blackman" url="blackman.html"/> @@ -20,12 +21,16 @@ <mapID target="bohmanwin" url="bohmanwin.html"/> <mapID target="boxcar" url="boxcar.html"/> <mapID target="buffer" url="buffer.html"/> +<mapID target="buttap" url="buttap.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="cheb" url="cheb.html"/> +<mapID target="cheb1ap" url="cheb1ap.html"/> <mapID target="cheb1ord" url="cheb1ord.html"/> +<mapID target="cheb2ap" url="cheb2ap.html"/> <mapID target="cheb2ord" url="cheb2ord.html"/> <mapID target="chebwin" url="chebwin.html"/> <mapID target="cheby1" url="cheby1.html"/> @@ -36,8 +41,10 @@ <mapID target="cmorwavf" url="cmorwavf.html"/> <mapID target="convmtx" url="convmtx.html"/> <mapID target="corrmtx" url="corrmtx.html"/> +<mapID target="cplxreal" url="cplxreal.html"/> <mapID target="cummax" url="cummax.html"/> <mapID target="cummin" url="cummin.html"/> +<mapID target="czt" url="czt.html"/> <mapID target="db" url="db.html"/> <mapID target="db2pow" url="db2pow.html"/> <mapID target="dctmtx" url="dctmtx.html"/> @@ -45,13 +52,18 @@ <mapID target="dftmtx" url="dftmtx.html"/> <mapID target="diric" url="diric.html"/> <mapID target="downsample" url="downsample.html"/> +<mapID target="dst1" url="dst1.html"/> <mapID target="dutycycle" url="dutycycle.html"/> <mapID target="ellip" url="ellip.html"/> +<mapID target="ellipap" url="ellipap.html"/> <mapID target="ellipord" url="ellipord.html"/> <mapID target="enbw" url="enbw.html"/> <mapID target="eqtflength" url="eqtflength.html"/> <mapID target="falltime" url="falltime.html"/> +<mapID target="fft" url="fft.html"/> +<mapID target="fft2" url="fft2.html"/> <mapID target="fftfilt" url="fftfilt.html"/> +<mapID target="fht" url="fht.html"/> <mapID target="filternorm" url="filternorm.html"/> <mapID target="filtfilt" url="filtfilt.html"/> <mapID target="filtic" url="filtic.html"/> @@ -60,8 +72,10 @@ <mapID target="firtype" url="firtype.html"/> <mapID target="flattopwin" url="flattopwin.html"/> <mapID target="fracshift" url="fracshift.html"/> +<mapID target="freqs" url="freqs.html"/> <mapID target="fwhm" url="fwhm.html"/> <mapID target="fwhmjlt" url="fwhmjlt.html"/> +<mapID target="fwht" url="fwht.html"/> <mapID target="gauspuls" url="gauspuls.html"/> <mapID target="gaussdesign" url="gaussdesign.html"/> <mapID target="gaussian" url="gaussian.html"/> @@ -70,14 +84,25 @@ <mapID target="goertzel" url="goertzel.html"/> <mapID target="grpdelay" url="grpdelay.html"/> <mapID target="hann" url="hann.html"/> +<mapID target="hanning" url="hanning.html"/> <mapID target="helperHarmonicDistortionAmplifier" url="helperHarmonicDistortionAmplifier.html"/> +<mapID target="hilbert1" url="hilbert1.html"/> +<mapID target="hurst" url="hurst.html"/> <mapID target="icceps" url="icceps.html"/> +<mapID target="idct1" url="idct1.html"/> +<mapID target="idct2" url="idct2.html"/> +<mapID target="idst1" url="idst1.html"/> +<mapID target="ifft" url="ifft.html"/> +<mapID target="ifft2" url="ifft2.html"/> +<mapID target="ifht" url="ifht.html"/> +<mapID target="ifwht" url="ifwht.html"/> <mapID target="iirlp2mb" url="iirlp2mb.html"/> <mapID target="impinvar" url="impinvar.html"/> <mapID target="impz" url="impz.html"/> <mapID target="impzlength" url="impzlength.html"/> <mapID target="interp" url="interp.html"/> <mapID target="intfilt" url="intfilt.html"/> +<mapID target="invfreq" url="invfreq.html"/> <mapID target="invimpinvar" url="invimpinvar.html"/> <mapID target="is2rc" url="is2rc.html"/> <mapID target="isallpass" url="isallpass.html"/> @@ -107,6 +132,7 @@ <mapID target="movingrms" url="movingrms.html"/> <mapID target="mscohere" url="mscohere.html"/> <mapID target="musicBase" url="musicBase.html"/> +<mapID target="ncauer" url="ncauer.html"/> <mapID target="nnls" url="nnls.html"/> <mapID target="nuttallwin" url="nuttallwin.html"/> <mapID target="parzenwin" url="parzenwin.html"/> @@ -114,6 +140,7 @@ <mapID target="pchips" url="pchips.html"/> <mapID target="peak2peak" url="peak2peak.html"/> <mapID target="peak2rms" url="peak2rms.html"/> +<mapID target="pei_tseng_notch" url="pei_tseng_notch.html"/> <mapID target="peig" url="peig.html"/> <mapID target="periodogram" url="periodogram.html"/> <mapID target="phaseInputParseAs_ab" url="phaseInputParseAs_ab.html"/> @@ -138,9 +165,11 @@ <mapID target="rc2is" url="rc2is.html"/> <mapID target="rc2lar" url="rc2lar.html"/> <mapID target="rc2poly" url="rc2poly.html"/> +<mapID target="rceps" url="rceps.html"/> <mapID target="rcosdesign" url="rcosdesign.html"/> <mapID target="rectpuls" url="rectpuls.html"/> <mapID target="rectwin" url="rectwin.html"/> +<mapID target="remez1" url="remez1.html"/> <mapID target="resample" url="resample.html"/> <mapID target="residued" url="residued.html"/> <mapID target="residuez" url="residuez.html"/> @@ -159,6 +188,9 @@ <mapID target="sgolayfilt" url="sgolayfilt.html"/> <mapID target="shanwavf" url="shanwavf.html"/> <mapID target="shiftdata" url="shiftdata.html"/> +<mapID target="sigmoid_train" url="sigmoid_train.html"/> +<mapID target="sinetone" url="sinetone.html"/> +<mapID target="sinewave" url="sinewave.html"/> <mapID target="slewrate" url="slewrate.html"/> <mapID target="sos2cell" url="sos2cell.html"/> <mapID target="sos2ss" url="sos2ss.html"/> @@ -167,11 +199,16 @@ <mapID target="sosbreak" url="sosbreak.html"/> <mapID target="sosfilt" url="sosfilt.html"/> <mapID target="specgram" url="specgram.html"/> +<mapID target="spectral_adf" url="spectral_adf.html"/> +<mapID target="spectral_xdf" url="spectral_xdf.html"/> +<mapID target="spencer" url="spencer.html"/> <mapID target="ss2sos" url="ss2sos.html"/> <mapID target="statelevels" url="statelevels.html"/> +<mapID target="stft" url="stft.html"/> <mapID target="stmcb" url="stmcb.html"/> <mapID target="strips" url="strips.html"/> <mapID target="subspaceMethodsInputParser" url="subspaceMethodsInputParser.html"/> +<mapID target="synthesis" url="synthesis.html"/> <mapID target="tf2sos" url="tf2sos.html"/> <mapID target="tf2zp" url="tf2zp.html"/> <mapID target="tf2zpk" url="tf2zpk.html"/> @@ -190,13 +227,17 @@ <mapID target="upsamplefill" url="upsamplefill.html"/> <mapID target="var" url="var.html"/> <mapID target="vco" url="vco.html"/> +<mapID target="wconv" url="wconv.html"/> <mapID target="welchwin" url="welchwin.html"/> <mapID target="window" url="window.html"/> <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="yulewalker" url="yulewalker.html"/> <mapID target="zerocrossing" url="zerocrossing.html"/> <mapID target="zp2sos" url="zp2sos.html"/> +<mapID target="zp2ss" url="zp2ss.html"/> +<mapID target="zp2tf" url="zp2tf.html"/> <mapID target="zplane" url="zplane.html"/> </map>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/jhelptoc.xml b/help/en_US/scilab_en_US_help/jhelptoc.xml index ee5518c..4db2aa2 100644 --- a/help/en_US/scilab_en_US_help/jhelptoc.xml +++ b/help/en_US/scilab_en_US_help/jhelptoc.xml @@ -2,7 +2,7 @@ <!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 1.0//EN" "http://java.sun.com/products/javahelp/toc_1_0.dtd"> <toc version="1.0"> <tocitem target="index" text="FOSSEE Signal Processing Toolbox"> -<tocitem target="section_cc2bc01c47967d47fcf3507a91d572ba" text="FOSSEE Signal Processing Toolbox"> +<tocitem target="section_5118e822ecc2888aa80042108de4932e" text="FOSSEE Signal Processing Toolbox"> <tocitem target="ac2poly" text="ac2poly"/> <tocitem target="ac2rc" text="ac2rc"/> <tocitem target="arParEst" text="arParEst"/> @@ -12,6 +12,7 @@ <tocitem target="aryule" text="aryule"/> <tocitem target="barthannwin" text="barthannwin"/> <tocitem target="bartlett" text="bartlett"/> +<tocitem target="besselap" text="besselap"/> <tocitem target="besself" text="besself"/> <tocitem target="bitrevorder" text="bitrevorder"/> <tocitem target="blackman" text="blackman"/> @@ -20,12 +21,16 @@ <tocitem target="bohmanwin" text="bohmanwin"/> <tocitem target="boxcar" text="boxcar"/> <tocitem target="buffer" text="buffer"/> +<tocitem target="buttap" text="buttap"/> <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="cheb" text="cheb"/> +<tocitem target="cheb1ap" text="cheb1ap"/> <tocitem target="cheb1ord" text="cheb1ord"/> +<tocitem target="cheb2ap" text="cheb2ap"/> <tocitem target="cheb2ord" text="cheb2ord"/> <tocitem target="chebwin" text="chebwin"/> <tocitem target="cheby1" text="cheby1"/> @@ -36,8 +41,10 @@ <tocitem target="cmorwavf" text="cmorwavf"/> <tocitem target="convmtx" text="convmtx"/> <tocitem target="corrmtx" text="corrmtx"/> +<tocitem target="cplxreal" text="cplxreal"/> <tocitem target="cummax" text="cummax"/> <tocitem target="cummin" text="cummin"/> +<tocitem target="czt" text="czt"/> <tocitem target="db" text="db"/> <tocitem target="db2pow" text="db2pow"/> <tocitem target="dctmtx" text="dctmtx"/> @@ -45,13 +52,18 @@ <tocitem target="dftmtx" text="dftmtx"/> <tocitem target="diric" text="diric"/> <tocitem target="downsample" text="downsample"/> +<tocitem target="dst1" text="dst1"/> <tocitem target="dutycycle" text="dutycycle"/> <tocitem target="ellip" text="ellip"/> +<tocitem target="ellipap" text="ellipap"/> <tocitem target="ellipord" text="ellipord"/> <tocitem target="enbw" text="enbw"/> <tocitem target="eqtflength" text="eqtflength"/> <tocitem target="falltime" text="falltime"/> +<tocitem target="fft" text="fft"/> +<tocitem target="fft2" text="fft2"/> <tocitem target="fftfilt" text="fftfilt"/> +<tocitem target="fht" text="fht"/> <tocitem target="filternorm" text="filternorm"/> <tocitem target="filtfilt" text="filtfilt"/> <tocitem target="filtic" text="filtic"/> @@ -60,8 +72,10 @@ <tocitem target="firtype" text="firtype"/> <tocitem target="flattopwin" text="flattopwin"/> <tocitem target="fracshift" text="fracshift"/> +<tocitem target="freqs" text="freqs"/> <tocitem target="fwhm" text="fwhm"/> <tocitem target="fwhmjlt" text="fwhmjlt"/> +<tocitem target="fwht" text="fwht"/> <tocitem target="gauspuls" text="gauspuls"/> <tocitem target="gaussdesign" text="gaussdesign"/> <tocitem target="gaussian" text="gaussian"/> @@ -70,14 +84,25 @@ <tocitem target="goertzel" text="goertzel"/> <tocitem target="grpdelay" text="grpdelay"/> <tocitem target="hann" text="hann"/> +<tocitem target="hanning" text="hanning"/> <tocitem target="helperHarmonicDistortionAmplifier" text="helperHarmonicDistortionAmplifier"/> +<tocitem target="hilbert1" text="hilbert1"/> +<tocitem target="hurst" text="hurst"/> <tocitem target="icceps" text="icceps"/> +<tocitem target="idct1" text="idct1"/> +<tocitem target="idct2" text="idct2"/> +<tocitem target="idst1" text="idst1"/> +<tocitem target="ifft" text="ifft"/> +<tocitem target="ifft2" text="ifft2"/> +<tocitem target="ifht" text="ifht"/> +<tocitem target="ifwht" text="ifwht"/> <tocitem target="iirlp2mb" text="iirlp2mb"/> <tocitem target="impinvar" text="impinvar"/> <tocitem target="impz" text="impz"/> <tocitem target="impzlength" text="impzlength"/> <tocitem target="interp" text="interp"/> <tocitem target="intfilt" text="intfilt"/> +<tocitem target="invfreq" text="invfreq"/> <tocitem target="invimpinvar" text="invimpinvar"/> <tocitem target="is2rc" text="is2rc"/> <tocitem target="isallpass" text="isallpass"/> @@ -107,6 +132,7 @@ <tocitem target="movingrms" text="movingrms"/> <tocitem target="mscohere" text="mscohere"/> <tocitem target="musicBase" text="musicBase"/> +<tocitem target="ncauer" text="ncauer"/> <tocitem target="nnls" text="nnls"/> <tocitem target="nuttallwin" text="nuttallwin"/> <tocitem target="parzenwin" text="parzenwin"/> @@ -114,6 +140,7 @@ <tocitem target="pchips" text="pchips"/> <tocitem target="peak2peak" text="peak2peak"/> <tocitem target="peak2rms" text="peak2rms"/> +<tocitem target="pei_tseng_notch" text="pei_tseng_notch"/> <tocitem target="peig" text="peig"/> <tocitem target="periodogram" text="periodogram"/> <tocitem target="phaseInputParseAs_ab" text="phaseInputParseAs_ab"/> @@ -138,9 +165,11 @@ <tocitem target="rc2is" text="rc2is"/> <tocitem target="rc2lar" text="rc2lar"/> <tocitem target="rc2poly" text="rc2poly"/> +<tocitem target="rceps" text="rceps"/> <tocitem target="rcosdesign" text="rcosdesign"/> <tocitem target="rectpuls" text="rectpuls"/> <tocitem target="rectwin" text="rectwin"/> +<tocitem target="remez1" text="remez1"/> <tocitem target="resample" text="resample"/> <tocitem target="residued" text="residued"/> <tocitem target="residuez" text="residuez"/> @@ -159,6 +188,9 @@ <tocitem target="sgolayfilt" text="sgolayfilt"/> <tocitem target="shanwavf" text="shanwavf"/> <tocitem target="shiftdata" text="shiftdata"/> +<tocitem target="sigmoid_train" text="sigmoid_train"/> +<tocitem target="sinetone" text="sinetone"/> +<tocitem target="sinewave" text="sinewave"/> <tocitem target="slewrate" text="slewrate"/> <tocitem target="sos2cell" text="sos2cell"/> <tocitem target="sos2ss" text="sos2ss"/> @@ -167,11 +199,16 @@ <tocitem target="sosbreak" text="sosbreak"/> <tocitem target="sosfilt" text="sosfilt"/> <tocitem target="specgram" text="specgram"/> +<tocitem target="spectral_adf" text="spectral_adf"/> +<tocitem target="spectral_xdf" text="spectral_xdf"/> +<tocitem target="spencer" text="spencer"/> <tocitem target="ss2sos" text="ss2sos"/> <tocitem target="statelevels" text="statelevels"/> +<tocitem target="stft" text="stft"/> <tocitem target="stmcb" text="stmcb"/> <tocitem target="strips" text="strips"/> <tocitem target="subspaceMethodsInputParser" text="subspaceMethodsInputParser"/> +<tocitem target="synthesis" text="synthesis"/> <tocitem target="tf2sos" text="tf2sos"/> <tocitem target="tf2zp" text="tf2zp"/> <tocitem target="tf2zpk" text="tf2zpk"/> @@ -190,14 +227,18 @@ <tocitem target="upsamplefill" text="upsamplefill"/> <tocitem target="var" text="var"/> <tocitem target="vco" text="vco"/> +<tocitem target="wconv" text="wconv"/> <tocitem target="welchwin" text="welchwin"/> <tocitem target="window" text="window"/> <tocitem target="wkeep" text="wkeep"/> <tocitem target="wrev" text="wrev"/> <tocitem target="xcorr2" text="xcorr2"/> <tocitem target="xcov1" text="xcov1"/> +<tocitem target="yulewalker" text="yulewalker"/> <tocitem target="zerocrossing" text="zerocrossing"/> <tocitem target="zp2sos" text="zp2sos"/> +<tocitem target="zp2ss" text="zp2ss"/> +<tocitem target="zp2tf" text="zp2tf"/> <tocitem target="zplane" text="zplane"/> </tocitem> </tocitem> diff --git a/help/en_US/sigmoid_train.xml b/help/en_US/sigmoid_train.xml new file mode 100644 index 0000000..07a86b7 --- /dev/null +++ b/help/en_US/sigmoid_train.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from sigmoid_train.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="sigmoid_train" 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>sigmoid_train</refname> + <refpurpose>funcprot(0);</refpurpose> + </refnamediv> + +</refentry> diff --git a/help/en_US/sinetone.xml b/help/en_US/sinetone.xml new file mode 100644 index 0000000..ce0e9f7 --- /dev/null +++ b/help/en_US/sinetone.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from sinetone.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="sinetone" 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>sinetone</refname> + <refpurpose>Return a sinetone of the input</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + y= sinetone(FREQ) + y= sinetone(FREQ, RATE) + y= sinetone(FREQ, RATE, SEC) + y= sinetone(FREQ, RATE, SEC, AMPL) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>FREQ:</term> + <listitem><para> frequency of sinetone</para></listitem></varlistentry> + <varlistentry><term>RATE:</term> + <listitem><para> Sampling rate</para></listitem></varlistentry> + <varlistentry><term>SEC:</term> + <listitem><para> Length in seconds</para></listitem></varlistentry> + <varlistentry><term>AMPL:</term> + <listitem><para> Amplitude</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Return a sinetone of frequency FREQ with a length of SEC seconds atsampling rate RATE and with amplitude AMPL.The arguments FREQ and AMPL may be vectors of common size.The defaults are RATE = 8000, SEC = 1, and AMPL = 64. +</para> +</refsection> +</refentry> diff --git a/help/en_US/sinewave.xml b/help/en_US/sinewave.xml new file mode 100644 index 0000000..bcc785d --- /dev/null +++ b/help/en_US/sinewave.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from sinewave.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="sinewave" 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>sinewave</refname> + <refpurpose>Return an M-element vector with I-th element given by 'sin(2* pi *(I+D-1)/N).'</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + y= sinewave(M) + y= sinewave(M,N) + y= sinewave(M,N,D) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>M:</term> + <listitem><para> Input vector</para></listitem></varlistentry> + <varlistentry><term>N:</term> + <listitem><para> The default value for N is M</para></listitem></varlistentry> + <varlistentry><term>D:</term> + <listitem><para> The default value for D is 0</para></listitem></varlistentry> + <varlistentry><term>AMPL:</term> + <listitem><para> Amplitude</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Return an M-element vector with I-th element given by 'sin(2* pi *(I+D-1)/N).' +</para> +</refsection> +</refentry> diff --git a/help/en_US/spectral_adf.xml b/help/en_US/spectral_adf.xml new file mode 100644 index 0000000..164d3e0 --- /dev/null +++ b/help/en_US/spectral_adf.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from spectral_adf.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="spectral_adf" 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>spectral_adf</refname> + <refpurpose>Return the spectral density estimator given a vector of autocovariances C, window name WIN, and bandwidth, B.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + spectral_adf(C) + spectral_adf(C, WIN) + spectral_adf(C, WIN, B) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>C:</term> + <listitem><para> Autocovariances</para></listitem></varlistentry> + <varlistentry><term>WIN:</term> + <listitem><para> Window names</para></listitem></varlistentry> + <varlistentry><term>B:</term> + <listitem><para> Bandwidth</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Return the spectral density estimator given a vector ofautocovariances C, window name WIN, and bandwidth, B. +The window name, e.g., "triangle" or "rectangle" is used to search for a function called 'WIN_lw'. +If WIN is omitted, the triangle window is used. +If B is omitted, '1 / sqrt (length (C))' is used. +</para> +</refsection> +</refentry> diff --git a/help/en_US/spectral_xdf.xml b/help/en_US/spectral_xdf.xml new file mode 100644 index 0000000..04cc793 --- /dev/null +++ b/help/en_US/spectral_xdf.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from spectral_xdf.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="spectral_xdf" 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>spectral_xdf</refname> + <refpurpose>Return the spectral density estimator given a data vector X, window name WIN, and bandwidth, B.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + spectral_xdf(X) + spectral_xdf(X, WIN) + spectral_xdf(X, WIN, B) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X:</term> + <listitem><para> Data Vector</para></listitem></varlistentry> + <varlistentry><term>WIN:</term> + <listitem><para> Window names</para></listitem></varlistentry> + <varlistentry><term>B:</term> + <listitem><para> Bandwidth</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Return the spectral density estimator given a data vector X, window name WIN, and bandwidth, B. +The window name, e.g., "triangle" or "rectangle" is used to search for a function called 'WIN_lw'. +If WIN is omitted, the triangle window is used. +If B is omitted, '1 / sqrt (length (X))' is used. +</para> +</refsection> +</refentry> diff --git a/help/en_US/spencer.xml b/help/en_US/spencer.xml new file mode 100644 index 0000000..66b1570 --- /dev/null +++ b/help/en_US/spencer.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from spencer.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="spencer" 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>spencer</refname> + <refpurpose>Return Spencer's 15 point moving average of each column of X.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + spencer(X) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X:</term> + <listitem><para> Real scalar or vector</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Return Spencer's 15 point moving average of each column of X. +</para> +</refsection> +</refentry> diff --git a/help/en_US/stft.xml b/help/en_US/stft.xml new file mode 100644 index 0000000..2449be3 --- /dev/null +++ b/help/en_US/stft.xml @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from stft.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="stft" 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>stft</refname> + <refpurpose>Compute the short-time Fourier transform of the vector X</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + Y = stft (X) + Y = stft (X, WIN_SIZE) + Y = stft (X, WIN_SIZE, INC) + Y = stft (X, WIN_SIZE, INC, NUM_COEF) + Y = stft (X, WIN_SIZE, INC, NUM_COEF, WIN_TYPE) + [Y,C] = stft (X) + [Y,C] = stft (X, WIN_SIZE) + [Y,C] = stft (X, WIN_SIZE, INC) + [Y,C] = stft (X, WIN_SIZE, INC, NUM_COEF) + [Y,C] = stft (X, WIN_SIZE, INC, NUM_COEF, WIN_TYPE) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>X:</term> + <listitem><para> Real scalar or vector</para></listitem></varlistentry> + <varlistentry><term>WIN_SIZE:</term> + <listitem><para> Size of the window used</para></listitem></varlistentry> + <varlistentry><term>INC:</term> + <listitem><para> Increment</para></listitem></varlistentry> + <varlistentry><term>WIN_TYPE:</term> + <listitem><para> Type of window</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Compute the short-time Fourier transform of the vector X with NUM_COEF coefficients by applying a window of WIN_SIZE data points and an increment of INC points. + </para> + <para> +Before computing the Fourier transform, one of the following windows is applied: + </para> + <para> +"hanning" -> win_type = 1 + </para> + <para> +"hamming" -> win_type = 2 + </para> + <para> +"rectangle" -> win_type = 3 + </para> + <para> +The window names can be passed as strings or by the WIN_TYPE number. + </para> + <para> +The following defaults are used for unspecified arguments:WIN_SIZE= 80, INC = 24, NUM_COEF = 64, and WIN_TYPE = 1. + </para> + <para> +Y = stft (X, ...)' returns the absolute values of the Fourier coefficients according to the NUM_COEF positive frequencies. + </para> + <para> +'[Y, C] = stft (x, ...)' returns the entire STFT-matrix Y and a 3-element vector C containing the window size, increment, and window type, which is needed by the 'synthesis' function. +</para> +</refsection> +</refentry> diff --git a/help/en_US/synthesis.xml b/help/en_US/synthesis.xml new file mode 100644 index 0000000..b1c1270 --- /dev/null +++ b/help/en_US/synthesis.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from synthesis.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="synthesis" 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>synthesis</refname> + <refpurpose>Compute a signal from its short-time Fourier transform</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + X= synthesis(Y,C) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>Y:</term> + <listitem><para> Shirt-time fourier transform</para></listitem></varlistentry> + <varlistentry><term>C:</term> + <listitem><para> 3-element vector C specifying window size, increment, window type.</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Compute a signal from its short-time Fourier transform Y and a 3-element vector C specifying window size, increment, and window type. +The values Y and C can be derived by +[Y, C] = stft (X , ...) +</para> +</refsection> +</refentry> diff --git a/help/en_US/wconv.xml b/help/en_US/wconv.xml new file mode 100644 index 0000000..acbf777 --- /dev/null +++ b/help/en_US/wconv.xml @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from wconv.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="wconv" 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>wconv</refname> + <refpurpose>Performs 1D or 2D convolution.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + y = wconv (type, x, f) + y = wconv (type, x, f, shape) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>type:</term> + <listitem><para> convolution type.</para></listitem></varlistentry> + <varlistentry><term>x:</term> + <listitem><para> Signal vector or matrix.</para></listitem></varlistentry> + <varlistentry><term>f:</term> + <listitem><para> FIR filter coefficients.</para></listitem></varlistentry> + <varlistentry><term>shape:</term> + <listitem><para> Shape.</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It performs 1D or 2D convolution between the signal x and the filter coefficients f. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +a = [1 2 3 4 5] +b = [7 8 9 10] +wconv(1,a,b) +ans = +7 22 46 80 114 106 85 50 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/yulewalker.xml b/help/en_US/yulewalker.xml new file mode 100644 index 0000000..5fdac3c --- /dev/null +++ b/help/en_US/yulewalker.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from yulewalker.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="yulewalker" 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>yulewalker</refname> + <refpurpose>Fit an AR (p)-model with Yule-Walker estimates given a vector C of autocovariances '[gamma_0, ..., gamma_p]'.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + A = yulewalker(C) + [A,V]= yulewalker(C) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>C:</term> + <listitem><para> Autocovariances</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Fit an AR (p)-model with Yule-Walker estimates given a vector C of autocovariances '[gamma_0, ..., gamma_p]'. +Returns the AR coefficients, A, and the variance of white noise, V. +</para> +</refsection> +</refentry> diff --git a/help/en_US/zp2ss.xml b/help/en_US/zp2ss.xml new file mode 100644 index 0000000..64b0594 --- /dev/null +++ b/help/en_US/zp2ss.xml @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from zp2ss.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="zp2ss" 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>zp2ss</refname> + <refpurpose>Converts zeros / poles to state space.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [a, b, c, d] = zp2ss (z, p, k) + [a, b, c] = zp2ss (z, p, k) + [a, b] = zp2ss (z, p, k) + a = zp2ss (z, p, k) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>z:</term> + <listitem><para> Zeros</para></listitem></varlistentry> + <varlistentry><term>p:</term> + <listitem><para> Poles</para></listitem></varlistentry> + <varlistentry><term>k:</term> + <listitem><para> Leading coefficient</para></listitem></varlistentry> + <varlistentry><term>a:</term> + <listitem><para> State space parameter</para></listitem></varlistentry> + <varlistentry><term>a:</term> + <listitem><para> State space parameter</para></listitem></varlistentry> + <varlistentry><term>b:</term> + <listitem><para> State space parameter</para></listitem></varlistentry> + <varlistentry><term>c:</term> + <listitem><para> State space parameter</para></listitem></varlistentry> + <varlistentry><term>d:</term> + <listitem><para> State space parameter</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It converts zeros / poles to state space. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +z = [1 2 3] +p = [4 5 6] +k = 5 +[a, b, c, d] = zp2ss (z, p, k) +a = + +-0.00000 0.00000 -1.20000 +-10.00000 0.00000 -7.40000 +0.00000 10.00000 15.00000 + +b = + +-5.7000 +-31.5000 +45.0000 + +c = + +0.00000 0.00000 1.00000 + +d = 5 + ]]></programlisting> +</refsection> +</refentry> diff --git a/help/en_US/zp2tf.xml b/help/en_US/zp2tf.xml new file mode 100644 index 0000000..c9e16af --- /dev/null +++ b/help/en_US/zp2tf.xml @@ -0,0 +1,72 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from zp2tf.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="zp2tf" 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>zp2tf</refname> + <refpurpose>Converts zeros / poles to a transfer function.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [num, den] = zp2tf (z, p, k) + num = zp2tf (z, p, k) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>z:</term> + <listitem><para> Zeros</para></listitem></varlistentry> + <varlistentry><term>p:</term> + <listitem><para> Poles</para></listitem></varlistentry> + <varlistentry><term>k:</term> + <listitem><para> Leading coefficient</para></listitem></varlistentry> + <varlistentry><term>Num:</term> + <listitem><para> Numerator of the transfer function</para></listitem></varlistentry> + <varlistentry><term>den:</term> + <listitem><para> Denomenator of the transfer function</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +It converts zeros / poles to a transfer function. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +z = [1 2 3] +p = [4 5 6] +k = 5 +[num, den] = zp2tf (z, p, k) +num = + +5 -30 55 -30 + +den = + +1 -15 74 -120 + ]]></programlisting> +</refsection> +</refentry> diff --git a/jar/scilab_en_US_help.jar b/jar/scilab_en_US_help.jar Binary files differindex 20f69e8..b832229 100644 --- a/jar/scilab_en_US_help.jar +++ b/jar/scilab_en_US_help.jar diff --git a/macros/czt.sci b/macros/czt.sci index b027489..84a0253 100644 --- a/macros/czt.sci +++ b/macros/czt.sci @@ -1,4 +1,23 @@ function y = czt(x, varargin) +//Chirp Z Transform +//Calling Sequence +//czt (x) +//czt (x, m) +//czt (x, m, w) +//czt (x, m, w, a) +//Parameters +//x: Input scalar or vector +//m: Total Number of steps +//w: ratio between points in each step +//a: point in the complex plane +//Description +//This is an Octave function. +//Chirp z-transform. Compute the frequency response starting at a and stepping by w for m steps. a is a point in the complex plane, and w is the ratio between points in each step (i.e., radius increases exponentially, and angle increases linearly). +//Examples +// m = 32; ## number of points desired +// w = exp(-j*2*pi*(f2-f1)/((m-1)*Fs)); ## freq. step of f2-f1/m +// a = exp(j*2*pi*f1/Fs); ## starting at frequency f1 +// y = czt(x, m, w, a); funcprot(0); lhs= argn(1); diff --git a/macros/dst1.sci b/macros/dst1.sci index 3b3b4b6..7f2165f 100644 --- a/macros/dst1.sci +++ b/macros/dst1.sci @@ -1,5 +1,14 @@ function y = dst1(x, varargin) - +//Computes the type I discrete sine transform of x +//Calling Sequence +//y= dst1(x) +//y= dst1(x,n) +//Parameters +//x: real or complex valued vector +//n= Length to which x is trimmed before transform +//Description +//This is an Octave function. +//Computes the type I discrete sine transform of x. If n is given, then x is padded or trimmed to length n before computing the transform. If x is a matrix, compute the transform along the columns of the the matrix. funcprot(0); lhs= argn(1); diff --git a/macros/fwht.sci b/macros/fwht.sci index 280bbee..e0a15ff 100644 --- a/macros/fwht.sci +++ b/macros/fwht.sci @@ -1,4 +1,28 @@ function y = fwht(x, varargin) +//Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm +//Calling Sequence +//fwht (x) +//fwht (x, n) +//fwht (x, n, order) +//Parameters +//x: real or complex valued scalar or vector +//n: x is truncated or extended to have length n +//order: Specification of order in which coefficients should be arranged +//Description +//Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm. If the input is a matrix, the FWHT is calculated along the columns of x. +// +//The number of elements of x must be a power of 2; if not, the input will be extended and filled with zeros. If a second argument is given, the input is truncated or extended to have length n. +// +//The third argument specifies the order in which the returned Walsh-Hadamard transform coefficients should be arranged. The order may be any of the following strings: +// +//"sequency" +//The coefficients are returned in sequency order. This is the default if order is not given. +// +//"hadamard" +//The coefficients are returned in Hadamard order. +// +//"dyadic" +//The coefficients are returned in Gray code order. funcprot(0); rhs= argn(2); diff --git a/macros/hilbert1.sci b/macros/hilbert1.sci index 864067f..1c0fe0e 100644 --- a/macros/hilbert1.sci +++ b/macros/hilbert1.sci @@ -1,4 +1,26 @@ function h= hilbert1(f, varargin) +//Analytic extension of real valued signal. +//Calling Sequence +// h= hilbert1(f) +// h= hilbert1(f,N) +// h= hilbert1(f,N,dim) +//Parameters +//f: real or complex valued scalar or vector +//N: The result will have length N +//dim : It analyses the input in this dimension +//Description +//h = hilbert (f) computes the extension of the real valued signal f to an analytic signal. If f is a matrix, the transformation is applied to each column. For N-D arrays, the transformation is applied to the first non-singleton dimension. +// +//real (h) contains the original signal f. imag (h) contains the Hilbert transform of f. +// +//hilbert1 (f, N) does the same using a length N Hilbert transform. The result will also have length N. +// +//hilbert1 (f, [], dim) or hilbert1 (f, N, dim) does the same along dimension dim. +//Examples +//## notice that the imaginary signal is phase-shifted 90 degrees +// t=linspace(0,10,256); +// z = hilbert1(sin(2*pi*0.5*t)); +// grid on; plot(t,real(z),';real;',t,imag(z),';imag;'); funcprot(0); rhs= argn(2); diff --git a/macros/hurst.sci b/macros/hurst.sci index 1a99f8c..27507fb 100644 --- a/macros/hurst.sci +++ b/macros/hurst.sci @@ -1,5 +1,13 @@ function y = hurst(x) - +// Estimate the Hurst parameter of sample X via the rescaled r statistic. +//Calling Sequence +//hurst(X) +//variable=hurst(X) +//Parameters +//X: X is a matrix, the parameter of sample X via the rescaled r statistic +//Description +//This is an Octave function. +//This function estimates the Hurst parameter of sample X via the rescaled rstatistic. funcprot(0); rhs= argn(2); if(rhs<1 | rhs>1) diff --git a/macros/ifht.sci b/macros/ifht.sci index aacbd7a..7f865cb 100644 --- a/macros/ifht.sci +++ b/macros/ifht.sci @@ -1,4 +1,22 @@ function m = ifht(d, varargin) +//Calculate the inverse Fast Hartley Transform of real input D +//Calling Sequence +//m= ifht (d) +//m= ifht (d,n) +//m= ifht (d,n,dim) +//Parameters +//d: real or complex valued scalar or vector +//n: Similar to the options of FFT function +//dim: Similar to the options of FFT function +//Description +//Calculate the inverse Fast Hartley Transform of real input d. If d is a matrix, the inverse Hartley transform is calculated along the columns by default. The options n and dim are similar to the options of FFT function. +// +//The forward and inverse Hartley transforms are the same (except for a scale factor of 1/N for the inverse hartley transform), but implemented using different functions. +// +//The definition of the forward hartley transform for vector d, m[K] = 1/N \sum_{i=0}^{N-1} d[i]*(cos[K*2*pi*i/N] + sin[K*2*pi*i/N]), for 0 <= K < N. m[K] = 1/N \sum_{i=0}^{N-1} d[i]*CAS[K*i], for 0 <= K < N. +//Examples +//ifht(1 : 4) +//ifht(1:4, 2) funcprot(0); rhs= argn(2); if(rhs<1 | rhs>3) diff --git a/macros/invfreq.sci b/macros/invfreq.sci index dde23ef..a720115 100644 --- a/macros/invfreq.sci +++ b/macros/invfreq.sci @@ -1,6 +1,28 @@ function [B,A] = invfreq(H,F,nB,nA,W,iter,tol, plane) - - +// Calculates inverse frequency vectors +// +// Calling Sequence +//[B,A] = invfreq(H,F,nB,nA) +//[B,A] = invfreq(H,F,nB,nA,W) +//[B,A] = invfreq(H,F,nB,nA,W,[],[],plane) +//[B,A] = invfreq(H,F,nB,nA,W,iter,tol,plane) +// +// Parameters +// H: desired complex frequency response,It is assumed that A and B are real polynomials, hence H is one-sided. +// F: vector of frequency samples in radians +// nA: order of denominator polynomial A +// nB: order of numerator polynomial B +// +// Description +//Fit filter B(z)/A(z) or B(s)/A(s) to complex frequency response at frequency points F. A and B are real polynomial coefficients of order nA and nB respectively. Optionally, the fit-errors can be weighted vs frequency according to the weights W. Also, the transform plane can be specified as either 's' for continuous time or 'z' for discrete time. 'z' is chosen by default. Eventually, Steiglitz-McBride iterations will be specified by iter and tol. +// +// Examples +// [B,A] = butter(12,1/4); +// [H,w] = freqz(B,A,128); +// [Bh,Ah] = invfreq(H,F,4,4); +// Hh = freqz(Bh,Ah); +// disp(sprintf('||frequency response error|| = %f',norm(H-Hh))); +// funcprot(0); lhs= argn(1); rhs= argn(2); Binary files differdiff --git a/macros/rceps.sci b/macros/rceps.sci index 065e482..8b4d89a 100644 --- a/macros/rceps.sci +++ b/macros/rceps.sci @@ -1,5 +1,17 @@ function [y, xm]= rceps(x) - +//Produce the cepstrum of the signal x, and if desired, the minimum phase reconstruction of the signal x. +//Calling Sequence +//[y, xm] = rceps(x) +//Parameters +//x: real or complex vector input +//Produce the cepstrum of the signal x, and if desired, the minimum phase reconstruction of the signal x. If x is a matrix, do so for each column of the matrix. +//Examples +// f0 = 70; Fs = 10000; # 100 Hz fundamental, 10kHz sampling rate +// a = poly (0.985 * exp (1i*pi*[0.1, -0.1, 0.3, -0.3])); # two formants +// s = 0.005 * randn (1024, 1); # Noise excitation signal +// s(1:Fs/f0:length(s)) = 1; # Impulse glottal wave +// x = filter (1, a, s); # Speech signal in x +// [y, xm] = rceps (x .* hanning (1024)); # cepstrum and min phase reconstruction funcprot(0) lhs= argn(1) rhs= argn(2) diff --git a/macros/remez1.sci b/macros/remez1.sci index aabb25e..0400d90 100644 --- a/macros/remez1.sci +++ b/macros/remez1.sci @@ -1,4 +1,19 @@ function b = remez1(n,f,a, varargin) +//Parks-McClellan optimal FIR filter design +//Calling Sequence +//b = remez1 (n, f, a) +//b = remez1 (n, f, a, w) +//b = remez1 (n, f, a, w, ftype) +//b = remez1 (n, f, a, w, ftype, griddensity) +//Parameters +//n: gives the number of taps in the returned filter +//f:gives frequency at the band edges [b1 e1 b2 e2 b3 e3 …] +//a:gives amplitude at the band edges [a(b1) a(e1) a(b2) a(e2) …] +//w:gives weighting applied to each band +//ftype:is "bandpass", "hilbert" or "differentiator" +//griddensity:determines how accurately the filter will be constructed. The minimum value is 16, but higher numbers are slower to compute. +//Description +//Frequency is in the range (0, 1), with 1 being the Nyquist frequency. funcprot(0); rhs= argn(2); diff --git a/macros/sinetone.sci b/macros/sinetone.sci index 006a2e0..407fa45 100644 --- a/macros/sinetone.sci +++ b/macros/sinetone.sci @@ -1,5 +1,17 @@ function y= sinetone(x, varargin) - +//Return a sinetone of the input +//Calling Sequence +//y= sinetone(FREQ) +//y= sinetone(FREQ, RATE) +//y= sinetone(FREQ, RATE, SEC) +//y= sinetone(FREQ, RATE, SEC, AMPL) +//Parameters +//FREQ: frequency of sinetone +//RATE: Sampling rate +//SEC: Length in seconds +//AMPL: Amplitude +//Description +//Return a sinetone of frequency FREQ with a length of SEC seconds atsampling rate RATE and with amplitude AMPL.The arguments FREQ and AMPL may be vectors of common size.The defaults are RATE = 8000, SEC = 1, and AMPL = 64. funcprot(0); rhs= argn(2); if(rhs<1 | rhs>4) diff --git a/macros/sinewave.sci b/macros/sinewave.sci index d5bdfa9..5263f35 100644 --- a/macros/sinewave.sci +++ b/macros/sinewave.sci @@ -1,5 +1,16 @@ function y= sinewave(x, varargin) - +//Return an M-element vector with I-th element given by 'sin(2* pi *(I+D-1)/N).' +//Calling Sequence +//y= sinewave(M) +//y= sinewave(M,N) +//y= sinewave(M,N,D) +//Parameters +//M: Input vector +//N: The default value for N is M +//D: The default value for D is 0 +//AMPL: Amplitude +//Description +//Return an M-element vector with I-th element given by 'sin(2* pi *(I+D-1)/N).' funcprot(0); rhs= argn(2); if(rhs<1 | rhs>3) diff --git a/macros/spectral_adf.sci b/macros/spectral_adf.sci index ea81f42..38b3990 100644 --- a/macros/spectral_adf.sci +++ b/macros/spectral_adf.sci @@ -1,5 +1,20 @@ function y= spectral_adf(x, varargin) +// Return the spectral density estimator given a vector of autocovariances C, window name WIN, and bandwidth, B. +//Calling Sequence +//spectral_adf(C) +//spectral_adf(C, WIN) +//spectral_adf(C, WIN, B) +//Parameters +//C: Autocovariances +//WIN: Window names +//B: Bandwidth +//Description +//Return the spectral density estimator given a vector ofautocovariances C, window name WIN, and bandwidth, B. +//The window name, e.g., "triangle" or "rectangle" is used to search for a function called 'WIN_lw'. +//If WIN is omitted, the triangle window is used. +//If B is omitted, '1 / sqrt (length (C))' is used. + funcprot(0); rhs= argn(2); if(rhs<1 | rhs>3) diff --git a/macros/spectral_xdf.sci b/macros/spectral_xdf.sci index fe93327..f0d457b 100644 --- a/macros/spectral_xdf.sci +++ b/macros/spectral_xdf.sci @@ -1,5 +1,18 @@ function y= spectral_xdf(x, varargin) - +// Return the spectral density estimator given a data vector X, window name WIN, and bandwidth, B. +//Calling Sequence +//spectral_xdf(X) +//spectral_xdf(X, WIN) +//spectral_xdf(X, WIN, B) +//Parameters +//X: Data Vector +//WIN: Window names +//B: Bandwidth +//Description +//Return the spectral density estimator given a data vector X, window name WIN, and bandwidth, B. +//The window name, e.g., "triangle" or "rectangle" is used to search for a function called 'WIN_lw'. +//If WIN is omitted, the triangle window is used. +//If B is omitted, '1 / sqrt (length (X))' is used. funcprot(0); rhs= argn(2); if(rhs<1 | rhs>3) diff --git a/macros/spencer.sci b/macros/spencer.sci index 537ca8a..63a1b83 100644 --- a/macros/spencer.sci +++ b/macros/spencer.sci @@ -1,5 +1,11 @@ function y= spencer(x) - +//Return Spencer's 15 point moving average of each column of X. +//Calling Sequence +//spencer(X) +//Parameters +//X: Real scalar or vector +//Description +//Return Spencer's 15 point moving average of each column of X. funcprot(0); rhs= argn(2); diff --git a/macros/stft.sci b/macros/stft.sci index 01d8f9b..7c30360 100644 --- a/macros/stft.sci +++ b/macros/stft.sci @@ -1,4 +1,39 @@ function [y,c]= stft(x, varargin) +//Compute the short-time Fourier transform of the vector X +//Calling Sequence +//Y = stft (X) +//Y = stft (X, WIN_SIZE) +//Y = stft (X, WIN_SIZE, INC) +//Y = stft (X, WIN_SIZE, INC, NUM_COEF) +//Y = stft (X, WIN_SIZE, INC, NUM_COEF, WIN_TYPE) +//[Y,C] = stft (X) +//[Y,C] = stft (X, WIN_SIZE) +//[Y,C] = stft (X, WIN_SIZE, INC) +//[Y,C] = stft (X, WIN_SIZE, INC, NUM_COEF) +//[Y,C] = stft (X, WIN_SIZE, INC, NUM_COEF, WIN_TYPE) +//Parameters +//X: Real scalar or vector +//WIN_SIZE: Size of the window used +//INC: Increment +//WIN_TYPE: Type of window +//Description +//Compute the short-time Fourier transform of the vector X with NUM_COEF coefficients by applying a window of WIN_SIZE data points and an increment of INC points. +// +//Before computing the Fourier transform, one of the following windows is applied: +// +//"hanning" -> win_type = 1 +// +//"hamming" -> win_type = 2 +// +//"rectangle" -> win_type = 3 +// +//The window names can be passed as strings or by the WIN_TYPE number. +// +//The following defaults are used for unspecified arguments:WIN_SIZE= 80, INC = 24, NUM_COEF = 64, and WIN_TYPE = 1. +// +//Y = stft (X, ...)' returns the absolute values of the Fourier coefficients according to the NUM_COEF positive frequencies. +// +//'[Y, C] = stft (x, ...)' returns the entire STFT-matrix Y and a 3-element vector C containing the window size, increment, and window type, which is needed by the 'synthesis' function. funcprot(0); lhs= argn(1); diff --git a/macros/synthesis.sci b/macros/synthesis.sci index e787c86..7224686 100644 --- a/macros/synthesis.sci +++ b/macros/synthesis.sci @@ -1,5 +1,14 @@ function x= synthesis(Y,C) - +//Compute a signal from its short-time Fourier transform +//Calling Sequence +//X= synthesis(Y,C) +//Parameters +//Y: Shirt-time fourier transform +//C: 3-element vector C specifying window size, increment, window type. +//Description +//Compute a signal from its short-time Fourier transform Y and a 3-element vector C specifying window size, increment, and window type. +//The values Y and C can be derived by +//[Y, C] = stft (X , ...) funcprot(0); lhs= argn(1); rhs= argn(2); diff --git a/macros/yulewalker.sci b/macros/yulewalker.sci index ebcb8aa..40fcadb 100644 --- a/macros/yulewalker.sci +++ b/macros/yulewalker.sci @@ -1,5 +1,13 @@ function [A,V]= yulewalker(C) - +// Fit an AR (p)-model with Yule-Walker estimates given a vector C of autocovariances '[gamma_0, ..., gamma_p]'. +//Calling Sequence +//A = yulewalker(C) +//[A,V]= yulewalker(C) +//Parameters +//C: Autocovariances +//Description +//Fit an AR (p)-model with Yule-Walker estimates given a vector C of autocovariances '[gamma_0, ..., gamma_p]'. +//Returns the AR coefficients, A, and the variance of white noise, V. funcprot(0); lhs=argn(1); rhs= argn(2); |