<?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 - CNRS (France) 1996.
-->

<refentry xml:id="d2statio" 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>d2statio</refname>
	<refpurpose>Distance to stationarity</refpurpose>
  </refnamediv>

<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   	[D,F] = D2STATIO(SIG)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>	SIG :</term>
      <listitem><para> signal to be analyzed (real or complex).</para></listitem></varlistentry>
   <varlistentry><term>	D   :</term>
      <listitem><para> vector giving the distance to stationarity for each frequency.</para></listitem></varlistentry>
   <varlistentry><term>	F   :</term>
      <listitem><para> vector of frequency bins</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
d2statio evaluates the distance of the signal to stationarity, using the pseudo Wigner-Ville distribution.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
rand("seed",0);
sig = noisecg(128); 
[d,f] = d2statio(sig);
clf
subplot(211); plot(f,d);
xlabel(_('Frequency')); ylabel(_('Distance'));

sig = fmconst(128); 
[d,f] = d2statio(sig);
subplot(212);plot(f,d);
xlabel(_('Frequency')); ylabel(_('Distance'));
   ]]></programlisting>
  <scilab:image><![CDATA[
rand("seed",0);

clf; 
sig=noisecg(128); 
[d,f]=d2statio(sig);
subplot(211);plot(f,d); xlabel(_('Frequency')); ylabel(_('Distance'));

sig=fmconst(128); 
[d,f]=d2statio(sig);
subplot(212);plot(f,d); xlabel(_('Frequency')); ylabel(_('Distance'));

    ]]></scilab:image>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>H. Nahrstaedt - Aug 2010</member>
   <member>O. Lemoine - May 1996.</member>
   
   </simplelist>
</refsection>
</refentry>
