<?xml version="1.0" encoding="UTF-8"?>

<!--
 * 
 * This help file was generated from tftb_window.sci using help_from_sci().
 * 
 -->

<refentry version="5.0-subset Scilab" xml:id="tftb_window" 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:db="http://docbook.org/ns/docbook">

  <info>
    <pubdate>$LastChangedDate: 26-August-2010 $</pubdate>
  </info>

  <refnamediv>
    <refname>tftb_window</refname><refpurpose>Window generation.</refpurpose>
  </refnamediv>



<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   	H=tftb_window(N)
   	H=tftb_window(N,NAME)
   	H=tftb_window(N,NAME,PARAM)
   	H=tftb_window(N,NAME,PARAM,PARAM2)
   	H=tftb_window(...,'plot')
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>	N      :</term>
      <listitem><para> length of the window</para></listitem></varlistentry>
   <varlistentry><term>	NAME   :</term>
      <listitem><para> name of the window shape (default : Hamming)</para></listitem></varlistentry>
   <varlistentry><term>	PARAM  :</term>
      <listitem><para> optional parameter</para></listitem></varlistentry>
   <varlistentry><term>	PARAM2 :</term>
      <listitem><para> second optional parameters</para></listitem></varlistentry>
   <varlistentry><term>'plot':</term>
      <listitem><para>	if one input parameter is 'plot', the window will be plotted</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
	yields a window of length N with a given shape.
   </para>
   <para>
	Possible names are :
   </para>
   <para>
	'Hamming', 'Hanning', 'Nuttall',  'Papoulis', 'Harris',
   </para>
   <para>
	'Rect',    'Triang',  'Bartlett', 'BartHann', 'Blackman'
   </para>
   <para>
	'Gauss',   'Parzen',  'Kaiser',   'Dolph',    'Hanna'.
   </para>
   <para>
	'Nutbess', 'spline',  'Flattop'
   </para>
   <para>
	For the gaussian window, an optionnal parameter K
	sets the value at both extremities. The default value is 0.005
   </para>
   <para>
	For the Kaiser-Bessel window, an optionnal parameter
	sets the scale. The default value is 3*pi.
   </para>
   <para>
	For the Spline windows, h=tftb_window(N,'spline',nfreq,p)
	yields a spline weighting function of order p and frequency
	bandwidth proportional to nfreq.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
h=tftb_window(256,'Gauss',0.005);
plot(0:255, h); a=gca();a.data_bounds=([0,255,-0.1,1.1]); xgrid

   ]]></programlisting>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="dwindow">dwindow</link></member>
   </simplelist>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>H. Nahrstaedt - Aug 2010</member>
   <member>	F. Auger, June 1994 - November 1995.</member>
   <member>	Copyright (c) 1996 by CNRS (France).</member>
   </simplelist>
</refsection>
</refentry>
