diff options
| author | shamikam | 2017-11-07 15:59:48 +0530 |
|---|---|---|
| committer | shamikam | 2017-11-07 15:59:48 +0530 |
| commit | c0c0582462720ed597b00e116506570577614e89 (patch) | |
| tree | 31dedd23698e5357b19c810b7d7a8464100ef44a /help/en_US/welchwin.xml | |
| download | FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.gz FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.bz2 FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.zip | |
initial commit
Diffstat (limited to 'help/en_US/welchwin.xml')
| -rw-r--r-- | help/en_US/welchwin.xml | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/help/en_US/welchwin.xml b/help/en_US/welchwin.xml new file mode 100644 index 0000000..aad08db --- /dev/null +++ b/help/en_US/welchwin.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from welchwin.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="welchwin" 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>welchwin</refname> + <refpurpose>This function returns the filter coefficients of a Welch window.</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + w = welchwin (m) + w = welchwin (m, opt) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>m:</term> + <listitem><para> positive integer value</para></listitem></varlistentry> + <varlistentry><term>opt:</term> + <listitem><para> string value, takes "periodic" or "symmetric"</para></listitem></varlistentry> + <varlistentry><term>w:</term> + <listitem><para> output variable, vector of real numbers</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +This function returns the filter coefficients of a Welch window of length m supplied as input, to the output vector w. +The second parameter can take the values "periodic" or "symmetric", depending on which the corresponding form of window is returned. The default is symmetric. +For symmetric, the length should be an integer>2. For periodic, the length should be an integer>1. +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +welchwin(4,"symmetric") +ans = +0. +0.8888889 +0.8888889 +0. + ]]></programlisting> +</refsection> +</refentry> |