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

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

<refentry version="5.0-subset Scilab" xml:id="momttfr" 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">

  <info>
    <pubdate>$LastChangedDate: 20-August-2010 $</pubdate>
  </info>

  <refnamediv>
    <refname>momttfr</refname>
	<refpurpose>Time moments of a time-frequency representation</refpurpose>
  </refnamediv>

<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   	[FM,B2] = momttfr(TFR)
   	[FM,B2] = momttfr(TFR, METHOD)
   	[FM,B2] = momttfr(TFR, METHOD, FBMIN)
   	[FM,B2] = momttfr(TFR, METHOD, FBMIN, FBMAX)
   	[FM,B2] = momttfr(TFR, METHOD, FBMIN, FBMAX, FREQS)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>	TFR   :</term>
      <listitem><para> time-frequency representation ([Nrow,Ncol]=size(TFR)).</para></listitem></varlistentry>
   <varlistentry><term>	METHOD:</term>
      <listitem><para> chosen representation (name of the corresponding M-file).</para></listitem></varlistentry>
   <varlistentry><term>	FBMIN :</term>
      <listitem><para> smallest frequency bin (default : 1)</para></listitem></varlistentry>
   <varlistentry><term>	FBMAX :</term>
      <listitem><para> highest  frequency bin (default : Nrow)</para></listitem></varlistentry>
   <varlistentry><term>	FREQS :</term>
      <listitem><para> true frequency of each frequency bin. FREQS must be of length FBMAX-FBMIN+1.       (default : 0:step:(0.5-step) or -0.5:step:(0.5-step)         depending on METHOD)</para></listitem></varlistentry>
   <varlistentry><term>	FM    :</term>
      <listitem><para> averaged frequency     (first order moment)</para></listitem></varlistentry>
   <varlistentry><term>	B2    :</term>
      <listitem><para> frequency band         (second order moment)</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
momttfr computes the time moments of a time-frequency representation.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
sig = fmlin(128,0.1,0.4);
tfr = tfrwv(sig);
[fm,B2] = momttfr(tfr,'tfrwv');
subplot(211); plot(fm); subplot(212); plot(B2);

freqs = linspace(0,63/128,64);
tfr=tfrsp(sig);
[fm,B2] = momttfr(tfr,'tfrsp',1,64,freqs);
subplot(211); plot(fm); subplot(212); plot(B2);
   ]]></programlisting>
</refsection>

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

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>H. Nahrstaedt - Aug 2010</member>
   <member>F. Auger, August 1995.</member>
   <member>Copyright (c) 1996 by CNRS (France).</member>
   </simplelist>
</refsection>
</refentry>
