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

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

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


<refsynopsisdiv>
   <title>Syntax</title>
   <synopsis>
   w = gaussian (m)
   w = gaussian (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> integer value</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 a Gaussian convolution 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>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
// Define parameters
m = 21       // Length of the window
a = 0.4      // Width control (higher a = narrower window)
// Generate Gaussian window
w = gaussian(m, a)
// Plot the window
x = linspace(-(m-1)/2, (m-1)/2, m);
plot(x, w, '-o');
title('Gaussian Window');
xlabel('Samples');
ylabel('Amplitude');
xgrid;

   ]]></programlisting>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>Rashmi Patankar</member>
   </simplelist>
</refsection>
</refentry>
