autocorr.xml

<refentry id="autocorr">
<indexterm id="IndexAutocorr"><primary>autocorr</primary></indexterm>

  <refentryinfo><title>Array Operations: Autocorrelation</title></refentryinfo>
  <refmeta>
    <refentrytitle>autocorr</refentrytitle>
  </refmeta>

   <refnamediv>
    <refname>autocorr</refname>
    <refpurpose>
     Autocorrelation of a sequence.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
       This opcode takes in an input array and computes its autocorrelation.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
      <synopsis>kout[] <command>autocorr</command> kin[]</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kout[]</emphasis> -- output array containing the
      autocorrelation output. It will be created if it does not exist.
         </para>
       <para>
      <emphasis>kin[]</emphasis> -- input array containing the
      sequence for autocorrelation.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the autocorr opcode. It uses the file
    <ulink url="examples/autocorr.csd"><citetitle>autocorr.csd</citetitle></ulink>.</para>

      <example>
        <title>Example of the autocorr opcode.</title>

        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/autocorr.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="vectorial"><citetitle></citetitle>Vectorial opcodes</link>,
      <link linkend="arrayOpcodes"><citetitle></citetitle>array opcodes</link>
</para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namevictor;</member>
        <member>NUI Maynooth</member>
        <member>2021</member>
      </simplelist>
    </para>
    <para>New in version 6.16</para>
  </refsect1>
</refentry>