<?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>Syntax</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 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>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
flattopwin(8,"periodic")

   ]]></programlisting>
</refsection>
</refentry>
