summaryrefslogtreecommitdiff
path: root/help/en_US/chirp.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/chirp.xml')
-rw-r--r--help/en_US/chirp.xml62
1 files changed, 1 insertions, 61 deletions
diff --git a/help/en_US/chirp.xml b/help/en_US/chirp.xml
index 60fc279..4aa93a1 100644
--- a/help/en_US/chirp.xml
+++ b/help/en_US/chirp.xml
@@ -17,67 +17,7 @@
<refnamediv>
<refname>chirp</refname>
- <refpurpose>Chirp signal at time t.</refpurpose>
+ <refpurpose>This function evaluates a chirp signal at time t.</refpurpose>
</refnamediv>
-<refsynopsisdiv>
- <title>Calling Sequence</title>
- <synopsis>
- y = chirp(t)
- y = chirp(t, f0)
- y = chirp(t, f0, t1)
- y = chirp(t, f0, t1, f1)
- y = chirp(t, f0, t1, f1, form)
- y = chirp(t, f0, t1, f1, form, phase)
- </synopsis>
-</refsynopsisdiv>
-
-<refsection>
- <title>Parameters</title>
- <variablelist>
- <varlistentry><term>t:</term>
- <listitem><para> a vector of times to evaluate the chirp signal.</para></listitem></varlistentry>
- <varlistentry><term>f0:</term>
- <listitem><para> the frequency at t=0. [default value = 0 Hz]</para></listitem></varlistentry>
- <varlistentry><term>t1:</term>
- <listitem><para> some intermediate time. [default value = 1 sec] </para></listitem></varlistentry>
- <varlistentry><term>f1:</term>
- <listitem><para> frequency at t=t1. [default value = 100 Hz]</para></listitem></varlistentry>
- <varlistentry><term>form:</term>
- <listitem><para> string value, takes in "linear", "quadratic", "logarithmic". [default value = "linear"]</para></listitem></varlistentry>
- <varlistentry><term>phase:</term>
- <listitem><para> phase shift at t=0. [default value = 0]</para></listitem></varlistentry>
- <varlistentry><term>y:</term>
- <listitem><para> chirp signal value corresponding to t. </para></listitem></varlistentry>
- </variablelist>
-</refsection>
-
-<refsection>
- <title>Description</title>
- <para>
-This function evaluates a chirp signal at time t. A chirp signal is a frequency swept cosine wave.</para>
-<para>The first argument is a vector of times to evaluate the chirp signal, second argument is the frequency at t=0, third argument is time t1 and fourth argument is frequency at t1.
-The fifth argument is the form which takes in values "linear", "quadratic" and "logarithmic", the sixth argument gives the phase shift at t=0.
-</para>
-</refsection>
-
-<refsection>
- <title>Examples</title>
- <programlisting role="example"><![CDATA[
- t = [4,3,2,1];
- f0 = 4;
- t1 = 5;
- f1 = 0.9;
- form = "quadratic";
- y = chirp(t, f0, t1, f1, form)
- ]]></programlisting>
-</refsection>
-
-<refsection>
-<title>Modified by :</title>
-<simplelist type="vert">
-<member>Sonu Sharma, RGIT Mumbai (fellow at FOSSEE, IIT Bombay)</member>
- </simplelist>
-</refsection>
-
</refentry>