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

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

<refentry version="5.0-subset Scilab" xml:id="Ctfrdist" 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:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>Ctfrdist</refname>
	<refpurpose>Time frequency distance</refpurpose>
  </refnamediv>

<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   distance = Ctfrdist(TFR1, TFR2, dist_name)
   distance = Ctfrdist(TFR1, TFR2, dist_name, dist_coef)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>TFR1        :</term>
      <listitem><para> first TFR</para></listitem></varlistentry>
   <varlistentry><term>TFR2        :</term>
      <listitem><para> second TFR, the same size as previous one</para></listitem></varlistentry>
   <varlistentry><term>dist_name   :</term>
      <listitem><para> identifier of the distance to compute</para></listitem></varlistentry>
   <varlistentry><term>dist_coef   :</term>
      <listitem><para> optional parameter necessary for some distance       measures</para></listitem></varlistentry>
   <varlistentry><term>dist_name is one of the following :</term>
      <listitem>
		<para>
		<table>
			<tr><td valign="top"><emphasis role="bold">'Lq'</emphasis></td>
				<td>Lq distance, 'dist_coef > 0' is the parameter q</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'Quadratic'</emphasis></td>
				<td>Quadratic distance, no 'dist_coef' required</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'Correlation'</emphasis></td>
				<td>Correlation distance,  no 'dist_coef' required</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'Kolmogorov'</emphasis></td>
				<td>Kolmogorov distance, no 'dist_coef' required</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'Kullback'</emphasis></td>
				<td>Kullback distance, no 'dist_coef' required</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'Chernoff'</emphasis></td>
				<td>Chernoff distance, one 'dist_coef in [0;1]' required</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'Matusita'</emphasis></td>
				<td>Matusita distance, one 'dist_coef &gt;= 1' required</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'NLq'</emphasis></td>
				<td>Normalized Lq distance,'dist_coef &gt; 0' is q</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'LSD'</emphasis></td>
				<td>Log Spectral deviation, one 'dist_coef &gt; 0' required</td>
			</tr>
			<tr><td valign="top"><emphasis role="bold">'Jensen'</emphasis></td>
				<td>Jensen distance, one 'dist_coef &gt; 0' required</td>
			</tr>
		</table>
		</para>
	  </listitem>
	</varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
Computes distances between Time Frequency Representations (TFRs)
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
AF1 = Cambifunb(hilbert(sin(2*%pi*0.25*(1:128))) + 0.5*rand(1,128,'normal'),-63:64,128);
AF2 = Cambifunb(hilbert(sin(2*%pi*0.15*(1:128))) + 0.5*rand(1,128,'normal'),-63:64,128);
ker = Ctfrker(128,128,'WV');
Wigner_TFR1 = Caf2tfr(AF1,ker);
Wigner_TFR2 = Caf2tfr(AF2,ker);
dist_kolm = Ctfrdist(Wigner_TFR1, Wigner_TFR2, 'Kolmogorov');
   ]]></programlisting>
</refsection>

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

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>H. Nahrstaedt - Sep 2010</member>
   <member>Emmanuel Roy - 2000</member>
   </simplelist>
</refsection>
</refentry>
