diff options
| author | bgtushar | 2017-11-27 11:14:24 +0530 |
|---|---|---|
| committer | GitHub | 2017-11-27 11:14:24 +0530 |
| commit | 25a88252ee49c73acb18232f6e916d7742a1af80 (patch) | |
| tree | 9161ea9a7940e36a21f0855a7805e24f7b002d8a /help/en_US/sinetone.xml | |
| parent | e9ab4b0b52db51be30f4ac3d07673c20b48da13c (diff) | |
| parent | ff8b1285a880cc28c68d8b224b20b8ccff8e5422 (diff) | |
| download | FOSSEE-Signal-Processing-Toolbox-25a88252ee49c73acb18232f6e916d7742a1af80.tar.gz FOSSEE-Signal-Processing-Toolbox-25a88252ee49c73acb18232f6e916d7742a1af80.tar.bz2 FOSSEE-Signal-Processing-Toolbox-25a88252ee49c73acb18232f6e916d7742a1af80.zip | |
Merge pull request #5 from abhinavdronamraju/master
Help files created and Updated Readme.md
Diffstat (limited to 'help/en_US/sinetone.xml')
| -rw-r--r-- | help/en_US/sinetone.xml | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/help/en_US/sinetone.xml b/help/en_US/sinetone.xml new file mode 100644 index 0000000..ce0e9f7 --- /dev/null +++ b/help/en_US/sinetone.xml @@ -0,0 +1,54 @@ +<?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>Calling Sequence</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 atsampling 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> +</refsection> +</refentry> |