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

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

<refentry version="5.0-subset Scilab" xml:id="sinetone" 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:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>sinetone</refname>
    <refpurpose>Return a sinetone of the input</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Syntax</title>
   <synopsis>
   y= sinetone(freq)
   y= sinetone(freq, rate)
   y= sinetone(freq, rate, sec)
   y= sinetone(freq, rate, sec, ampl)
   
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
        <varlistentry>
            <term>freq:</term>
            <listitem><para> frequency of sinetone</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>rate:</term>
            <listitem><para> sampling rate</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>sec:</term>
            <listitem><para> length in seconds</para></listitem>
        </varlistentry>
        <varlistentry>
            <term>ampl:</term>
            <listitem><para> amplitude</para></listitem>
        </varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
Return a sinetone of frequency 'freq' with a length of 'sec' seconds at sampling rate 'rate' and with amplitude 'ampl'.
The arguments freq and ampl may be vectors of common size. The defaults are rate = 8000, sec = 1, and ampl = 64.
   </para>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
sinetone(5, 2, 1, 8)

   ]]></programlisting>
</refsection>
</refentry>
