<?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 CeCILL.
This source file is licensed as described in the file COPYING, which
you should have received as part of this distribution.  The terms
are also available at
http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
-->

<refentry xml:id="ambifuwb" 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>ambifuwb</refname>
	<refpurpose>Wide-band ambiguity function</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>
      [WAF,TAU,THETA] = ambifuwb(X)
      [WAF,TAU,THETA] = ambifuwb(X, FMIN)
      [WAF,TAU,THETA] = ambifuwb(X, FMIN, FMAX)
      [WAF,TAU,THETA] = ambifuwb(X, FMIN, FMAX, N)
      [WAF,TAU,THETA] = ambifuwb(X, FMIN, FMAX, N, TRACE)
      [WAF,TAU,THETA] = ambifuwb(...,'plot')
    </synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>
    <variablelist>

      <varlistentry>
        <term>X     :</term>
        <listitem>
          <para> real vector of length Nx : the signal (in time) to be
          analyzed.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term> FMIN:</term> 
        <listitem>
          <para>
            a positive scalar in ]0 0.5], the normalized lower
            frequency bound in (Hz) of the analyzed signal. When
            unspecified, you have to enter it at the command line from
          the plot of the spectrum. </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term> FMAX :</term> 
        <listitem>
          <para> a positive scalar in ]0 0.5], the normalized upper
          frequency bound (in Hz) of the analyzed signal.  When
          unspecified, you have to enter it at the command line from
          the plot of the spectrum.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>N :</term> 
        <listitem>
          <para>a positive integer: number of analyzed voices.  When
          unspecified, you have to enter it at the command line from
          the plot of the spectrum.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term> TRACE :</term> 
        <listitem>
          <para>A boolean (or a real scalar) if true (or nonzero),the
          progression of the algorithm is shown (default : %f).</para>
        </listitem>
      </varlistentry>

      <varlistentry><term>AF    :</term>
      <listitem>
        <para> matrix containing the coefficients of the ambiguity
        function. X-coordinate corresponds to the dual variable of
        scale parameter ; Y-coordinate corresponds to time delay, dual
        variable of frequency.</para>
      </listitem>
      </varlistentry>

      <varlistentry>
        <term>'plot' :</term>
        <listitem> 
          <para> When called with the additional argument 'plot',
          ambifuwb displays the squared modulus of the ambiguity
          function by means of contour.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>TAU   :</term>
        <listitem>
          <para> X-coordinate corresponding to time delay</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>THETA :</term>
        <listitem>
          <para> Y-coordinate corresponding to the log(scale) variable</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>
    <para>
      ambifuwb calculates the asymetric wide-band ambiguity function.
    </para>
  </refsection>

  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[
    sig = altes(128,0.1,0.45); 
    [TFR,T,F] = ambifuwb(sig,0.1,0.35,64);
    clf; gcf().color_map = jetcolormap(128);
    grayplot(T,F,TFR');
    ]]></programlisting>
    <scilab:image><![CDATA[
    sig=altes(128,0.1,0.45); 
    [TFR,T,F]=ambifuwb(sig,0.1,0.35,64);
    clf;gcf().color_map= jetcolormap(128);
    grayplot(T,F,TFR');
    ]]></scilab:image>
  </refsection>

  <refsection role="see also">
    <title>See also</title>
    <simplelist type="inline">
      <member><link linkend="ambifunb">ambifunb</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>H. Nahrstaedt - Aug 2010</member>
      <member>P. Goncalvez - December 1995, O. Lemoine - August 1996.</member>
    </simplelist>
  </refsection>
</refentry>
