summaryrefslogtreecommitdiff
path: root/help/en_US/bohmanwin.xml
blob: 082342dbf501914355e90c800a357a5012cf9727 (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
<?xml version="1.0" encoding="UTF-8"?>

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

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


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   y = bohmanwin (m)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>m:</term>
      <listitem><para> positive integer value</para></listitem></varlistentry>
   <varlistentry><term>y:</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 Bohman window of length m supplied as input, to the output vector y.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
bohmanwin(4)
ans  =
0.
0.6089978
0.6089978
0.
   ]]></programlisting>
</refsection>
</refentry>