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

<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="tftb_contents" xml:lang="en">
  <info>
    <pubdate>$LastChangedDate: 07-September-2010 $</pubdate>
  </info>
  <refnamediv>
    <refname>Overview of STFTb features</refname>
    <refpurpose>Scilab Time Frequency Toolbox</refpurpose>
  </refnamediv>
   <refsection>
    <title>Signal generation functions:</title>

    <variablelist>
    
   <varlistentry><term>Choice of the Instantaneous Amplitude     :</term>
      <listitem>
       <para><link linkend="amexpo1s">amexpo1s</link>  One-sided exponential amplitude modulation</para>
        <para><link linkend="amexpo2s">amexpo2s</link> Bilateral exponential amplitude modulation</para>
        <para><link linkend="amgauss">amgauss</link> Gaussian amplitude modulation</para>
        <para><link linkend="amrect">amrect</link> Rectangular amplitude modulation</para>
        <para><link linkend="amtriang">amtriang</link> Triangular amplitude modulation</para>
    </listitem>
   </varlistentry>
   
   <varlistentry><term>Choice of the Instantaneous Frequency   :</term>
   <listitem>
    <para><link linkend="fmconst">fmconst</link> Signal with constant frequency modulation</para>
   <para><link linkend="fmhyp">fmhyp</link> Signal with hyperbolic frequency modulation</para>
 <para><link linkend="fmlin">fmlin</link> Signal with linear frequency modulation</para>
 <para><link linkend="fmodany">fmodany</link> Signal with arbitrary frequency modulation</para>
 <para><link linkend="fmpar">fmpar</link> Signal with parabolic frequency modulation</para>
 <para><link linkend="fmpower">fmpower</link> Signal with power-law frequency modulation</para>
 <para><link linkend="fmsin">fmsin</link> Signal with sinusoidal frequency modulation</para>
 <para><link linkend="gdpower">gdpower</link> Signal with a power-law group delay</para>
  <para><link linkend="if2phase">if2phase</link> Generate the phase from the instantaneous frequency</para>
   </listitem>
   </varlistentry>
   
    <varlistentry><term>   Choice of Particular Signals   </term>
   <listitem>
    <para><link linkend="altes">altes</link> Altes signal in time domain</para>
 <para><link linkend="anaask">anaask</link> Amplitude Shift Keyed (ASK) signal</para>
 <para><link linkend="anabpsk">anabpsk</link> Binary Phase Shift Keyed (BPSK) signal</para>
 <para><link linkend="anafsk">anafsk</link> Frequency Shift Keyed (FSK) signal</para>
 <para><link linkend="anapulse">anapulse</link> Analytic projection of unit amplitude impulse signal</para>
 <para><link linkend="anaqpsk">anaqpsk</link> Quaternary Phase Shift Keyed (QPSK) signal</para>
 <para><link linkend="anasing">anasing</link> Lipschitz singularity</para>
 <para><link linkend="anastep">anastep</link> Analytic projection of unit step signal</para>
 <para><link linkend="atoms">atoms</link> Linear combination of elementary Gaussian atoms</para> 
 <para><link linkend="chirp">chirp</link> Evaluate a chirp signal at time t.  A chirp signal is a frequency swept cosine wave.</para> 
 <para><link linkend="dopnoise">dopnoise</link> Complex Doppler random signal</para>
 <para><link linkend="doppler">doppler</link> Complex Doppler signal</para>
 <para><link linkend="klauder">klauder</link> Klauder wavelet in time domain</para>
 <para><link linkend="mexhat">mexhat</link> Mexican hat wavelet in time domain</para>
  <para><link linkend="pulstran">pulstran</link> Puls generation</para>
   <para><link linkend="sawtooth">sawtooth</link> Generates a sawtooth wave </para>
 <para><link linkend="tftb_window">tftb_window</link> Window generation</para>
  <para><link linkend="griffitc">griffitc</link> Test signal example C of Griffiths' paper.</para>
    </listitem>
   </varlistentry>
   
   <varlistentry><term>   Noise Realizations   </term>
   <listitem>
 <para><link linkend="noisecg">noisecg</link> Analytic complex gaussian noise</para>
 <para><link linkend="noisecu">noisecu</link> Analytic complex uniform white noise</para>
    </listitem>
   </varlistentry>
  
    <varlistentry><term>   Modification   </term>
   <listitem>
 <para><link linkend="scale">scale</link> Scale a signal using the Mellin transform</para>
 <para><link linkend="sigmerge">sigmerge</link> Add two signals with a given energy ratio in dB</para>
    </listitem>
   </varlistentry>
    </variablelist>
  </refsection>
  
    <refsection>
    <title>Processing functions</title>
  <variablelist>
  
   <varlistentry><term>  Time-Domain Processing  </term>
      <listitem>
 <para><link linkend="ifestar2">ifestar2</link> Instantaneous frequency estimation using AR2 modelisation.</para>
 <para><link linkend="instfreq">instfreq</link> Instantaneous frequency estimation</para>
 <para><link linkend="loctime">loctime</link> Time localization characteristics</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term>  Frequency-Domain Processing  </term>
      <listitem>
 <para><link linkend="ffmt">ffmt</link> Fast Mellin transform</para>
 <para><link linkend="iffmt">iffmt</link> Inverse fast Mellin transform</para>
 <para><link linkend="locfreq">locfreq</link> Frequency localization characteristics</para>
 <para><link linkend="sgrpdlay">sgrpdlay</link> Group delay estimation</para>
  <para><link linkend="tftb_fft">tftb_fft</link> Fast Fourier transform</para>
 <para><link linkend="tftb_ifft">tftb_ifft</link> Inverse fast Fourier transform</para>
   <para><link linkend="frspec">frspec</link> Spectrum</para>
 <para><link linkend="frpowerspec">frpowerspec</link> Power spectrum</para>
  <para><link linkend="parafrep">parafrep</link> parametric frequency representation of a signal.</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term> Linear Time-Frequency Processing   </term>
      <listitem>
 <para><link linkend="tfrgabor">tfrgabor</link> Gabor representation</para>
 <para><link linkend="tfrstft">tfrstft</link> Short time Fourier transform</para>
   <para><link linkend="tfrsurf">tfrsurf</link> extract from a time-frequency representation the biggest energy dots</para>
    <para><link linkend="tfristft">tfristft</link> Inverse Short time Fourier transform.</para>
     <para><link linkend="tffilter">tffilter</link> Time frequency filtering of a signal.</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term>  Bilinear Time-Frequency Processing in the Cohen's Class   </term>
      <listitem>
  <para><link linkend="tfrbj">tfrbj</link> Born-Jordan distribution</para>                     
 <para><link linkend="tfrbud">tfrbud</link> Butterworth distribution</para>                   
 <para><link linkend="tfrcw">tfrcw</link> Choi-Williams distribution</para>                   
 <para><link linkend="tfrgrd">tfrgrd</link> Generalized rectangular distribution</para>        
 <para><link linkend="tfrmh">tfrmh</link> Margenau-Hill distribution</para>                    
 <para><link linkend="tfrmhs">tfrmhs</link> Margenau-Hill-Spectrogram distribution</para>     
 <para><link linkend="tfrmmce">tfrmmce</link> Minimum mean cross-entropy combination of spectrograms</para> 
 <para><link linkend="tfrpage">tfrpage</link> Page distribution</para>                          
 <para><link linkend="tfrpmh">tfrpmh</link> Pseudo Margenau-Hill distribution</para>          
 <para><link linkend="tfrppage">tfrppage</link> Pseudo Page distribution</para>                 
 <para><link linkend="tfrpwv">tfrpwv</link> Pseudo Wigner-Ville distribution</para>            
 <para><link linkend="tfrri">tfrri</link> Rihaczek distribution</para>                       
 <para><link linkend="tfrridb">tfrridb</link> Reduced interference distribution (Bessel window)</para>
 <para><link linkend="tfrridbn">tfrridbn</link> Reduced interference distribution (binomial window)</para>
 <para><link linkend="tfrridh">tfrridh</link> Reduced interference distribution (Hanning window)</para>
 <para><link linkend="tfrridt">tfrridt</link> Reduced interference distribution (triangular window)</para>
 <para><link linkend="tfrsp">tfrsp</link> Spectrogram distribution</para>                     
 <para><link linkend="tfrspwv">tfrspwv</link> Smoothed Pseudo Wigner-Ville distribution</para>   
 <para><link linkend="tfrwv">tfrwv</link> Wigner-Ville distribution</para>
 <para><link linkend="tfrzam">tfrzam</link> Zhao-Atlas-Marks distribution</para>    
  <para><link linkend="tfrspbk">tfrspbk</link> Smoothed Pseudo K-Bertrand time-frequency distribution.</para>   
       </listitem>
   </varlistentry>
   
      <varlistentry><term>  Bilinear Time-Frequency Processing in the Affine Class  </term>
      <listitem>
 <para><link linkend="tfrbert">tfrbert</link> Unitary Bertrand distribution</para>
 <para><link linkend="tfrdfla">tfrdfla</link> D-Flandrin distribution</para>
 <para><link linkend="tfrscalo">tfrscalo</link> Scalogram, for Morlet or Mexican hat wavelet</para>
 <para><link linkend="tfrspaw">tfrspaw</link> Smoothed Pseudo Affine Wigner distributions</para>
 <para><link linkend="tfrunter">tfrunter</link> Unterberger distribution, active or passive form</para>
  <para><link linkend="istfraff">istfraff</link> returns true is method is an affine time frequency representation.</para>
    <para><link linkend="lambdak">lambdak</link> Evaluate lambda function for Affine Wigner distribution.</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term>  Reassigned Time-Frequency Processing  </term>
      <listitem>
 <para><link linkend="tfrrgab">tfrrgab</link> Reassigned Gabor spectrogram</para>
 <para><link linkend="tfrrmsc">tfrrmsc</link> Reassigned Morlet Scalogram time-frequency distribution</para>
 <para><link linkend="tfrrpmh">tfrrpmh</link> Reassigned Pseudo Margenau-Hill distribution</para>
 <para><link linkend="tfrrppag">tfrrppag</link> Reassigned Pseudo Page distribution</para>
 <para><link linkend="tfrrpwv">tfrrpwv</link> Reassigned Pseudo Wigner-Ville distribution</para>
 <para><link linkend="tfrrsp">tfrrsp</link> Reassigned Spectrogram</para> 
 <para><link linkend="tfrrspwv">tfrrspwv</link> Reassigned Smoothed Pseudo WV distribution</para>
  <para><link linkend="tfrrstan">tfrrstan</link> Reassigned Stankovic distribution.</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term>  Ambiguity Functions  </term>
      <listitem>
       <para><link linkend="ambifunb">ambifunb</link> Narrow-band ambiguity function</para>
 <para><link linkend="ambifuwb">ambifuwb</link> Wide-band ambiguity function</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term> Post-Processing or Help to the Interpretation   </term>
      <listitem>
 <para><link linkend="friedman">friedman</link> Instantaneous frequency density</para>
 <para><link linkend="holder">holder</link> Estimation of the Holder exponent through an affine TFR</para>
 <para><link linkend="htl">htl</link> Hough transform for detection of lines in images</para>
 <para><link linkend="margtfr">margtfr</link> Marginals and energy of a time-frequency representation</para>
 <para><link linkend="midpoint">midpoint</link> Mid-point construction used in the interference diagram</para> 
 <para><link linkend="momftfr">momftfr</link> Frequency moments of a time-frequency representation</para>
 <para><link linkend="momttfr">momttfr</link> Time moments of a time-frequency representation</para>
 <para><link linkend="plotsid">plotsid</link> Schematic interference diagram of FM signals</para> 
 <para><link linkend="renyi">renyi</link> Measure Renyi information</para>
 <para><link linkend="ridges">ridges</link> Extraction of ridges from a reassigned TFR</para>
 <para><link linkend="tfrideal">tfrideal</link> Ideal TFR for given frequency laws</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term>  Visualization and backup   </term>
      <listitem>
       <para><link linkend="plotifl">plotifl</link> Plot normalized instantaneous frequency laws</para>
 <para><link linkend="tfrparam">tfrparam</link> Return the paramaters needed to display (or save) a TFR</para>
 <para><link linkend="tfrqview">tfrqview</link> Quick visualization of a time-frequency representation</para>
 <para><link linkend="tfrsave">tfrsave</link> Save the parameters of a time-frequency representation</para>
 <para><link linkend="tfrview">tfrview</link> Visualization of time-frequency representations</para>
       </listitem>
   </varlistentry>
   
      <varlistentry><term> Other   </term>
      <listitem>
  <para><link linkend="disprog">disprog</link> Display the progression of a loop</para>
 <para><link linkend="divider">divider</link> Find dividers of an integer, closest from the square root of the integer </para> 
 <para><link linkend="dwindow">dwindow</link> Derive a window</para>
 <para><link linkend="integ">integ</link> Approximate an integral</para>
 <para><link linkend="integ2d">integ2d</link> Approximate a 2-D integral</para>
 <para><link linkend="izak">izak</link> Inverse Zak transform</para>
 <para><link linkend="kaytth">kaytth</link> Computation of the Kay-Tretter filter</para>
 <para><link linkend="vecmodulo">vecmodulo</link> Congruence of a vector</para>
 <para><link linkend="odd">odd</link> Round towards nearest odd value</para>
 <para><link linkend="zak">zak</link> Zak transform</para>     
 <para><link linkend="rem">rem</link> Return the remainder of the division x/y </para>   
  <para><link linkend="rot90">rot90</link> rotates the given matrix clockwise by 90 degrees </para>   
    <para><link linkend="fzero">fzero</link> solves the scalar nonlinear equation such that F(X) == 0 </para>   
        <para><link linkend="d2statio">d2statio</link> Distance to stationarity</para>   
	 <para><link linkend="correlmx">correlmx</link> correlation matrix of a signal</para> 
	 <para><link linkend="gaussn">gaussn</link> generates the order n derivative of the gaussian window, centered at frequency f0</para> 
	 <para><link linkend="imextrac">imextrac</link> imextrac(Image) extract and isolate dots in a binary image</para> 
<para><link linkend="umaxbert">umaxbert</link> Determination of the maximum value of u for Bertrand distribution.</para> 
<para><link linkend="umaxdfla">umaxdfla</link> Determination of the maximum value of u for D-Flandrin distribution.</para> 
<para><link linkend="umaxunte">umaxunte</link> Determination of the maximum value of u for Unterberger distribution.</para> 
<para><link linkend="istfr1">istfr1</link> returns true is method is a time frequency representation of type 1 (positive and negative frequencies).</para> 
<para><link linkend="istfr2">istfr2</link> returns true is method is a time frequency representation of type 2 (only positive frequencies).</para> 
<para><link linkend="contwtgn">contwtgn</link> computes a continuous wavelet transform.</para> 
<para><link linkend="contwtgnmir">contwtgnmir</link> Continuous wavelet transform of mirrored 1-D signals</para> 
       </listitem>
   </varlistentry>
   
    </variablelist>
  </refsection>
  
    <refsection>
    <title>C - Toolbox functions</title>
  <variablelist>
  
   <varlistentry><term>  Time-Frequency representations  </term>
      <listitem>
 <para><link linkend="Ctfrbj">Ctfrbj</link> Born-Jordan time-frequency distribution.</para>
 <para><link linkend="Ctfrbud">Ctfrbud</link> Butterworth time-frequency distribution. </para>
 <para><link linkend="Ctfrcw">Ctfrcw</link> Choi-Williams time-frequency distribution.</para>
  <para><link linkend="Ctfrgrd">Ctfrgrd</link> Generalized rectangular time-frequency distribution.</para>
   <para><link linkend="Ctfrmh">Ctfrmh</link> Margenau-Hill time-frequency distribution.</para>
    <para><link linkend="Ctfrmhs">Ctfrmhs</link> Margenau-Hill-Spectrogram time-frequency distribution. </para>
     <para><link linkend="Ctfrmmce">Ctfrmmce</link> Minimum mean cross-entropy combination of spectrograms. </para>
      <para><link linkend="Ctfrpage">Ctfrpage</link> Page time-frequency distribution. </para>
      <para><link linkend="Ctfrpmh">Ctfrpmh</link> Pseudo Margenau-Hill time-frequency distribution. </para>
       <para><link linkend="Ctfrppage">Ctfrppage</link> Pseudo Page time-frequency distribution.</para>
        <para><link linkend="Ctfrpwv">Ctfrpwv</link> Pseudo Wigner-Ville time-frequency distribution. </para>
	 <para><link linkend="Ctfrri">Ctfrri</link> Rihaczek time-frequency distribution. </para>
	  <para><link linkend="Ctfrridb">Ctfrridb</link> Reduced Interference Distribution with Bessel kernel. </para>
	  <para><link linkend="Ctfrridbn">Ctfrridbn</link> Reduced Interference Distribution with binomial kernel.</para>
	  <para><link linkend="Ctfrridh">Ctfrridh</link> Reduced Interference Distribution with Hanning kernel. </para>
	  <para><link linkend="Ctfrridt">Ctfrridt</link> Reduced Interference Distribution with Triangular kernel.</para>
	  <para><link linkend="Ctfrrsp">Ctfrrsp</link> Reassigned Spectrogram</para>
	  <para><link linkend="Ctfrsp">Ctfrsp</link> Spectrogram Time Frequency distribution </para>
	  <para><link linkend="Ctfrspwv">Ctfrspwv</link> Smoothed Pseudo Wigner-Ville time-frequency distribution.</para>
	  <para><link linkend="Ctfrstft">Ctfrstft</link> Short time Fourier transform </para>
	  <para><link linkend="Ctfrwv">Ctfrwv</link> Wigner-Ville time-frequency distribution. </para>
	  <para><link linkend="Ctfrzam">Ctfrzam</link> Zao-Atlas-Marks time-frequency distribution.</para>
	  
       </listitem>
   </varlistentry>
   
   <varlistentry><term>   Ambiguity plane function  </term>
      <listitem>
 <para><link linkend="Cambifunb">Cambifunb</link> Ambiguity function</para>
 <para><link linkend="Ctfrker">Ctfrker</link> Time frequency representation kernel.</para>
 <para><link linkend="Caf2tfr">Caf2tfr</link> From ambiguity plane to time frequency plane</para>
        </listitem>
   </varlistentry>
   
   <varlistentry><term> Miscellanaeous functions </term>
      <listitem>
 <para><link linkend="Chtl">Chtl</link> Hough transform for detection of lines in images..</para>
 <para><link linkend="Ctfrdist">Ctfrdist</link> Time frequency distance measures</para>
 <para><link linkend="Ctfrreas">Ctfrreas</link> Time Frequency Representation reassignment</para>
 <para><link linkend="Cwindow">Cwindow</link> Window generation.</para>
        </listitem>
   </varlistentry>

    </variablelist>
  </refsection>
  
 <refsection>
    <title>Authors</title>
    <simplelist type="vert">
       <member>F. Auger, oct 1999.</member>
          <member>M. Davy, 2000.</member>
          <member>E. Roy, 2000.</member>
      <member>Holger Nahrstaedt - Aug 2010</member>
    </simplelist>
  </refsection>
</refentry>
