summaryrefslogtreecommitdiff
path: root/help/en_US/hanning.xml
blob: 5350656233d8b2dc94e77ebb7b301810d944bdb0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<?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>Return the filter coefficients of a Hanning window of length M</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   hanning (M)
   hanning (M, "periodic")
   hanning (M, "symmetric")
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>M:</term>
      <listitem><para> real scalar, which will be the length of hanning window</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
Return the filter coefficients of a Hanning window of length M.
If the optional argument "periodic" is given, the periodic form of the window is returned.  This is equivalent to the window of length M+1 with the last coefficient removed.  The optional argument "symmetric" is equivalent to not specifying a second argument.
</para>
</refsection>
</refentry>