<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="pvsinfo">
  <refmeta>
    <refentrytitle>pvsinfo</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>pvsinfo</refname>
    <refpurpose>
      Get information from a PVOC-EX formatted source.
      <indexterm id="IndexPvsinfo"><primary>pvsinfo</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Get format information about fsrc, whether created by an opcode such as pvsanal, or obtained from a PVOCEX file by pvsfread. This information is available at init time, and can be used to set parameters for other pvs opcodes, and in particular for creating function tables (e.g. for pvsftw), or setting the number of oscillators for pvsadsyn.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>ioverlap, inumbins, iwinsize, iformat <command>pvsinfo</command> fsrc</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ioverlap</emphasis> -- The stream overlap size.
    </para>

    <para>
      <emphasis>inumbins</emphasis> -- The number of analysis bins (amplitude+frequency) in fsrc. The underlying FFT size is calculated as (inumbins -1) * 2.
    </para>

    <para>
      <emphasis>iwinsize</emphasis> -- The analysis window size. May be larger than the FFT size.
    </para>

    <para>
      <emphasis>iformat</emphasis> -- The analysis frame format. If fsrc is created by an opcode, iformat will always be 0, signifying amplitude+frequency. If fsrc is defined from a PVOC-EX file, iformat may also have the value 1 or 2 (amplitude+phase, complex).
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      <informalexample>
        <programlisting>
fin                pvsfread  &quot;test.pvx&quot;    ; import pvocex file
iovl,inb,iws,ifmt  pvsinfo   fin           ; get inumbins info
ifn                ftgen     0,0,inb,10,1  ; and create f-table
        </programlisting>
      </informalexample>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namerichard;</member>
        <member>August 2001 </member>
      </simplelist>
    </para>

    <para>New in version 4.13</para>
  </refsect1>
</refentry>
