<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the Scilab time frequency toolbox.
This file must be used under the terms of the  terms of the GNU General Public License 
as published by the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 Copyright (c) 1995 Rice University
-->

<refentry xml:id="klauder" 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:scilab="http://www.scilab.org"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>klauder</refname>
	<refpurpose>Klauder wavelet in time domain</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>   	
      X = klauder(N)
      X = klauder(N, LAMBDA)
      X = klauder(N, LAMBDA, F0)
    </synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>	N      :</term>
        <listitem>
          <para>a positive scalar with integer value: the number of
          points in time</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>	LAMBDA :</term>
        <listitem>
          <para>a positive scalar: the attenuation factor or the envelope (default : 10)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>	F0     :</term>
        <listitem>
          <para>a scalar in [0 0.5]: the central frequency of the wavelet (default : 0.2)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>	X      :</term>
        <listitem>
          <para>a real column vector of size N: the klauder time samples.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>
    <para>
      klauder generates the KLAUDER wavelet in the time domain
      K(f) = e^{-2.pi.LAMBA.f} f^{2.pi.LAMBDA.F0-1/2}
    </para>
  </refsection>

  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[
    x1 = klauder(128); 
    x2 = klauder(128,5,0.01);
    clf; plot([x1 x2]);
    legend("lambda=10, f0=0.2","lambda=5,  f0=0.01");
    ]]></programlisting>
    <scilab:image><![CDATA[
    x1=klauder(128); 
    x2=klauder(128,5,0.01);
    clf;plot([x1 x2]);
    legend("lambda=10, f0=0.2","lambda=5,  f0=0.01");
    ]]></scilab:image>
  </refsection>

  <refsection role="see also">
    <title>See also</title>
    <simplelist type="inline">
      <member><link linkend="altes">altes</link></member>
      <member><link linkend="anasing">anasing</link></member>
      <member><link linkend="doppler">doppler</link></member>
      <member><link linkend="anafsk">anafsk</link></member>
      <member><link linkend="anastep">anastep</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>H. Nahrstaedt - Aug 2010</member>
      <member>P. Goncalves 9-95</member>
    </simplelist>
  </refsection>
</refentry>
