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

-->

<refentry xml:id="loctime" 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>loctime</refname><refpurpose>Time localization caracteristics.</refpurpose>
  </refnamediv>



  <refsynopsisdiv>
    <title>Calling Sequence</title>
    <synopsis>
      [TM,T]=loctime(SIG)
    </synopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Parameters</title>
    <variablelist>
      <varlistentry>
        <term>SIG:</term>
        <listitem>
          <para>a real vector</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>TM :</term>
        <listitem>
          <para>a real scalar: the averaged time center</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>T :</term>
        <listitem>
          <para>a real scalar: the time spreading.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection>
    <title>Description</title>
    <para>
      loctime computes the time localization	caracteristics of signal SIG.
    </para>
  </refsection>

  <refsection>
    <title>Examples</title>
    <programlisting role="example"><![CDATA[
    z=amgauss(160,80,50); 
    [tm,T]=loctime(z)
    ]]></programlisting>
  </refsection>

  <refsection>
    <title>See also</title>
    <simplelist type="inline">
      <member><link linkend="locfreq">locfreq</link></member>
    </simplelist>
  </refsection>

  <refsection>
    <title>Authors</title>
    <simplelist type="vert">
      <member>H. Nahrstaedt - Aug 2010</member>
      <member>	F. Auger, July 1995.</member>
    </simplelist>
  </refsection>
</refentry>
