summaryrefslogtreecommitdiff
path: root/help/en_US/nuttallwin.xml
blob: 5732027ba1588f5c4ca3e6ac29864c0eb0d7a7af (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="nuttallwin" 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>nuttallwin</refname>
    <refpurpose>This function returns the filter coefficients of a Blackman-Harris window.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   w = nuttallwin (m)
   w = nuttallwin (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 Blackman-Harris window defined by Nuttall 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.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
nuttallwin(2, "periodic")
ans  =
- 2.429D-17
1.
   ]]></programlisting>
</refsection>
</refentry>