summaryrefslogtreecommitdiff
path: root/help/en_US/mexihat.xml
blob: 81f77a1bf365f1019e6529fe411dca359504de74 (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 mexihat.sci using help_from_sci().
 *
 -->

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


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   [psi,x]=mexihat(lb,ub,n)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>lb:</term>
      <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry>
   <varlistentry><term>ub:</term>
      <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry>
   <varlistentry><term>n:</term>
      <listitem><para> Real strictly positive scalar number</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function which is built in scilab.
This function returns values of the Mexican hat wavelet in the specified interval at all the sample points.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
1.    [a,b]= mexihat(1,2,3)
//a =   [0.00000  -0.35197  -0.35214]
//b =   [1.0000   1.5000   2.0000]
2.    [a,b]= mexihat([1 2 3],1,1)
//a = [0;0;0]
//b = [1;1;1]
   ]]></programlisting>
</refsection>
</refentry>