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

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

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


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   w = gausswin (m)
   w = gausswin (m, a)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>m:</term>
      <listitem><para> positive integer value</para></listitem></varlistentry>
   <varlistentry><term>a:</term>
      <listitem><para> </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 Gaussian window of length m supplied as input, to the output vector w.
The second parameter is the width measured in sample rate/number of samples and should be f for time domain and 1/f for frequency domain. The width is inversely proportional to a.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
gausswin(3)
//ans  =
//0.2493522
//1.
//0.2493522
   ]]></programlisting>
</refsection>
</refentry>