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

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

<refentry version="5.0-subset Scilab" xml:id="tfrview" 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>tfrview</refname>
	<refpurpose>Visualization of time-frequency representations</refpurpose>
  </refnamediv>

<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   tfrview(TFR, SIG, T, METHOD, PARAM)
   tfrview(TFR, SIG, T, METHOD, PARAM, P1)
   tfrview(TFR, SIG, T, METHOD, PARAM, P1, P2)
   tfrview(TFR, SIG, T, METHOD, PARAM, P1, P2, P3)
   tfrview(TFR, SIG, T, METHOD, PARAM, P1, P2, P3, P4)
   tfrview(TFR, SIG, T, METHOD, PARAM, P1, P2, P3, P4, P5)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>TFR    :</term>
      <listitem><para> time-frequency representation.</para></listitem></varlistentry>
   <varlistentry><term>SIG    :</term>
      <listitem><para> signal in the time-domain.</para></listitem></varlistentry>
   <varlistentry><term>T      :</term>
      <listitem><para> time instants.</para></listitem></varlistentry>
   <varlistentry><term>METHOD :</term>
      <listitem><para> chosen representation (name of the corresponding sci-file)</para></listitem></varlistentry>
   <varlistentry><term>PARAM  :</term>
      <listitem><para> visualization parameter vector :  PARAM  = [DISPLAY LINLOG THRESHOLD LEVNUMB NF2 LAYOUT FS ISGRID fmin fmax] where</para></listitem></varlistentry>
   <varlistentry><term>DISPLAY :</term>
      <listitem><para> 1..5 for contour, imagesc, pcolor, surf or mesh</para></listitem></varlistentry>
   <varlistentry><term>LINLOG  :</term>
      <listitem><para>0/1 for linearly/logarithmically spaced levels</para></listitem></varlistentry>
   <varlistentry><term>THRESHOLD :</term>
      <listitem><para> is the visualization threshold, in %</para></listitem></varlistentry>
   <varlistentry><term>LEVELNUMB :</term>
      <listitem><para> is the number of levels used with contour</para></listitem></varlistentry>
   <varlistentry><term>NF2       :</term>
      <listitem><para> is the number of frequency bins displayed</para></listitem></varlistentry>
   <varlistentry><term>LAYOUT    :</term>
      <listitem><para> determines the layout of the figure : TFR alone (1),  TFR and SIG (2), TFR and spectrum (3), TFR and SIG and    spectrum (4), add 4 if you want a colorbar</para></listitem></varlistentry>
   <varlistentry><term>FS    :</term>
      <listitem><para>  is the sampling frequency (may be set to 1.0)</para></listitem></varlistentry>
   <varlistentry><term>ISGRID :</term>
      <listitem><para> depends on the grids' presence :  isgrid=isgridsig+2*isgridspec+4*isgridtfr        where isgridsig=1 if a grid is present on the signal and =0 if not, and so on</para></listitem></varlistentry>
   <varlistentry><term>fmin :</term>
      <listitem><para>  smallest normalized frequency</para></listitem></varlistentry>
   <varlistentry><term>fmax :</term>
      <listitem><para>  highest  normalized frequency</para></listitem></varlistentry>
   <varlistentry><term>P1..P5:</term>
      <listitem><para> parameters of the representation. Run the file tfrparam(METHOD) to know the meaning of P1..P5.  		</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
tfrview allows to visualize a time-frequency representation.
tfrview is called through tfrqview from any tfr* function.
</para>
</refsection>

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

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>H. Nahrstaedt, Aug 2010</member>
   <member>F. Auger, July 1994, July 1995 -</member>
   <member>O. Lemoine, October-November 1995, May-June 1996.</member>
   <member>F. Auger, May 1998.</member>
   <member>Copyright (c) CNRS - France 1996.</member>
   </simplelist>
</refsection>
</refentry>
