summaryrefslogtreecommitdiff
path: root/help/en_US/flattopwin.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/flattopwin.xml')
-rw-r--r--help/en_US/flattopwin.xml69
1 files changed, 69 insertions, 0 deletions
diff --git a/help/en_US/flattopwin.xml b/help/en_US/flattopwin.xml
new file mode 100644
index 0000000..d990123
--- /dev/null
+++ b/help/en_US/flattopwin.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from flattopwin.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="flattopwin" 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>flattopwin</refname>
+ <refpurpose>This function returns the filter coefficients of a Flat Top window.</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ w = flattopwin (m)
+ w = flattopwin (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 in "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 Flat Top 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.
+This window has low pass-band ripple but a high bandwidth.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+flattopwin(8,"periodic")
+ans =
+0.0009051
+- 0.0264124
+- 0.0555580
+0.4435496
+1.
+0.4435496
+- 0.0555580
+- 0.0264124
+ ]]></programlisting>
+</refsection>
+</refentry>