summaryrefslogtreecommitdiff
path: root/help/en_US/gauspuls.xml
blob: e24d9e450611bfd9c2b585b5d3f24ba19f83e153 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="gauspuls" 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>gauspuls</refname>
    <refpurpose></refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   [y]=gauspuls(t,fc,bw)
   [y]=gauspuls(t,fc)
   [y]=gauspuls(t)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>t:</term>
      <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry>
   <varlistentry><term>fc:</term>
      <listitem><para> Real non negative number or complex number</para></listitem></varlistentry>
   <varlistentry><term>bw:</term>
      <listitem><para> Real positive number or complex number</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function
This function returns a Gaussian RF pulse of unity amplitude at the times indicated in array t.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
1.    gauspuls(1,2,3)
ans= 1.427D-56
2.    gauspuls([1 2 3],1,1)
ans= 0.0281016    0.0000006    1.093D-14
   ]]></programlisting>
</refsection>
</refentry>