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

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

<refentry version="5.0-subset Scilab" xml:id="tfrsave" 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>tfrsave</refname><refpurpose>Save the parameters of a time-frequency representation.</refpurpose>
  </refnamediv>



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

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>	NAME   :</term>
      <listitem><para> name of the mat-file (less than 8 characters).</para></listitem></varlistentry>
   <varlistentry><term>	TFR    :</term>
      <listitem><para> time-frequency representation (MxN).</para></listitem></varlistentry>
   <varlistentry><term>	METHOD :</term>
      <listitem><para> chosen representation.	</para></listitem></varlistentry>
   <varlistentry><term>	SIG    :</term>
      <listitem><para> signal from which the TFR was obtained</para></listitem></varlistentry>
   <varlistentry><term>	T      :</term>
      <listitem><para> time instant(s)	   (default : (1:N)).</para></listitem></varlistentry>
   <varlistentry><term>	F      :</term>
      <listitem><para> frequency bins		   (default : linspace(0,0.5,M)).</para></listitem></varlistentry>
   <varlistentry><term>	P1..P5 :</term>
      <listitem><para> optional parameters : run the file tfrparam(METHOD) to know the meaning of P1..P5 for your method.</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
tfrsave saves the parameters of a time-frequency representation in the file
	NAME.dat. Two additional parameters are saved : TfrQView and
	TfrView. If you load the file 'name.dat' and do execstr(TfrQView), you
	will restart the display session under tfrqview ; if you do
	execstr(TfrView), you will display the representation by means of
	tfrview.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
sig=fmlin(64); tfr=tfrwv(sig);
tfrsave('wigner',tfr,'TFRWV',sig,1:64);
clear sig; clear tfr; load 'wigner.dat'; execstr(TfrQView);
   ]]></programlisting>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="tfrqview">tfrqview</link></member>
   <member><link linkend="tfrview">tfrview</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, August 1994 - O. Lemoine, June 1996.</member>
   <member>	Copyright (c) 1996 by CNRS (France).</member>
   </simplelist>
</refsection>
</refentry>
