← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/cacsd/help/en_US/armax.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/cacsd/help/en_US/armax.xml
11
11
 *
12
12
 -->
13
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="armax">
14
 
  <refnamediv>
15
 
    <refname>armax</refname>
16
 
    <refpurpose> armax identification</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[arc,la,lb,sig,resid]=armax(r,s,y,u,[b0f,prf])</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>y</term>
27
 
        <listitem>
28
 
          <para>output process  y(ny,n); ( ny: dimension of y , n : sample size)</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>u</term>
33
 
        <listitem>
34
 
          <para>input process   u(nu,n); ( nu: dimension of u , n : sample size)</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>r and s</term>
39
 
        <listitem>
40
 
          <para>auto-regression orders r &gt;=0 et s &gt;=-1</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
      <varlistentry>
44
 
        <term>b0f</term>
45
 
        <listitem>
46
 
          <para>optional parameter. Its default value is 0 and it means that the coefficient b0 must be identified. if bof=1 the b0 is supposed to be zero and is not identified</para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
      <varlistentry>
50
 
        <term>prf</term>
51
 
        <listitem>
52
 
          <para>optional parameter for display control. If prf =1, the default value,  a display of the identified Arma is given.</para>
53
 
        </listitem>
54
 
      </varlistentry>
55
 
      <varlistentry>
56
 
        <term>arc</term>
57
 
        <listitem>
58
 
          <para>a Scilab arma object (see armac)</para>
59
 
        </listitem>
60
 
      </varlistentry>
61
 
      <varlistentry>
62
 
        <term>la</term>
63
 
        <listitem>
64
 
          <para>is the list(a,a+eta,a-eta) ( la = a in dimension 1) ; where eta is the estimated standard deviation.  , a=[Id,a1,a2,...,ar] where each ai is a matrix of size (ny,ny)</para>
65
 
        </listitem>
66
 
      </varlistentry>
67
 
      <varlistentry>
68
 
        <term>lb</term>
69
 
        <listitem>
70
 
          <para>is the list(b,b+etb,b-etb) (lb =b in dimension 1) ; where etb is the estimated standard deviation. b=[b0,.....,b_s] where each bi is a matrix of size (nu,nu)</para>
71
 
        </listitem>
72
 
      </varlistentry>
73
 
      <varlistentry>
74
 
        <term>sig</term>
75
 
        <listitem>
76
 
          <para>is the estimated standard deviation of the noise and resid=[ sig*e(t0),....] (</para>
77
 
        </listitem>
78
 
      </varlistentry>
79
 
    </variablelist>
80
 
  </refsection>
81
 
  <refsection>
82
 
    <title>Description</title>
83
 
    <para>
84
 
      armax is used to identify the coefficients of a n-dimensional 
85
 
      ARX process
86
 
    </para>
87
 
    <programlisting role=""><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>armax</refname>
 
16
        <refpurpose> armax identification</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[arc,la,lb,sig,resid]=armax(r,s,y,u,[b0f,prf])</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>y</term>
 
27
                <listitem>
 
28
                    <para>output process  y(ny,n); ( ny: dimension of y , n : sample size)</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>u</term>
 
33
                <listitem>
 
34
                    <para>input process   u(nu,n); ( nu: dimension of u , n : sample size)</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>r and s</term>
 
39
                <listitem>
 
40
                    <para>auto-regression orders r &gt;=0 et s &gt;=-1</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
            <varlistentry>
 
44
                <term>b0f</term>
 
45
                <listitem>
 
46
                    <para>optional parameter. Its default value is 0 and it means that the coefficient b0 must be identified. if bof=1 the b0 is supposed to be zero and is not identified</para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
            <varlistentry>
 
50
                <term>prf</term>
 
51
                <listitem>
 
52
                    <para>optional parameter for display control. If prf =1, the default value,  a display of the identified Arma is given.</para>
 
53
                </listitem>
 
54
            </varlistentry>
 
55
            <varlistentry>
 
56
                <term>arc</term>
 
57
                <listitem>
 
58
                    <para>a Scilab arma object (see armac)</para>
 
59
                </listitem>
 
60
            </varlistentry>
 
61
            <varlistentry>
 
62
                <term>la</term>
 
63
                <listitem>
 
64
                    <para>is the list(a,a+eta,a-eta) ( la = a in dimension 1) ; where eta is the estimated standard deviation.  , a=[Id,a1,a2,...,ar] where each ai is a matrix of size (ny,ny)</para>
 
65
                </listitem>
 
66
            </varlistentry>
 
67
            <varlistentry>
 
68
                <term>lb</term>
 
69
                <listitem>
 
70
                    <para>is the list(b,b+etb,b-etb) (lb =b in dimension 1) ; where etb is the estimated standard deviation. b=[b0,.....,b_s] where each bi is a matrix of size (nu,nu)</para>
 
71
                </listitem>
 
72
            </varlistentry>
 
73
            <varlistentry>
 
74
                <term>sig</term>
 
75
                <listitem>
 
76
                    <para>is the estimated standard deviation of the noise and resid=[ sig*e(t0),....] (</para>
 
77
                </listitem>
 
78
            </varlistentry>
 
79
        </variablelist>
 
80
    </refsection>
 
81
    <refsection>
 
82
        <title>Description</title>
 
83
        <para>
 
84
            armax is used to identify the coefficients of a n-dimensional 
 
85
            ARX process
 
86
        </para>
 
87
        <programlisting role=""><![CDATA[ 
88
88
A(z^-1)y= B(z^-1)u + sig*e(t)
89
89
 ]]></programlisting>
90
 
    <para>
91
 
      where e(t) is a n-dimensional white noise with variance I.
92
 
      sig  an nxn matrix and A(z) and B(z):
93
 
    </para>
94
 
    <programlisting role=""><![CDATA[ 
 
90
        <para>
 
91
            where e(t) is a n-dimensional white noise with variance I.
 
92
            sig  an nxn matrix and A(z) and B(z):
 
93
        </para>
 
94
        <programlisting role=""><![CDATA[ 
95
95
A(z) = 1+a1*z+...+a_r*z^r; ( r=0 => A(z)=1)
96
96
B(z) = b0+b1*z+...+b_s z^s ( s=-1 => B(z)=0)
97
97
 ]]></programlisting>
98
 
    <para>
99
 
      for the method see Eykhoff in trends and progress in system identification, page 96.
100
 
      with  
101
 
      <literal>z(t)=[y(t-1),..,y(t-r),u(t),...,u(t-s)]</literal>
102
 
      and
103
 
      <literal>coef= [-a1,..,-ar,b0,...,b_s] </literal>
104
 
      we can write 
105
 
      <literal>y(t)= coef* z(t) + sig*e(t) </literal> and the algorithm minimises 
106
 
      <literal>sum_{t=1}^N ( [y(t)- coef'z(t)]^2)</literal>
107
 
      where t0=max(max(r,s)+1,1))).
108
 
    </para>
109
 
  </refsection>
110
 
  <refsection>
111
 
    <title>Examples</title>
112
 
    <programlisting role="example"><![CDATA[ 
 
98
        <para>
 
99
            for the method see Eykhoff in trends and progress in system identification, page 96.
 
100
            with  
 
101
            <literal>z(t)=[y(t-1),..,y(t-r),u(t),...,u(t-s)]</literal>
 
102
            and
 
103
            <literal>coef= [-a1,..,-ar,b0,...,b_s] </literal>
 
104
            we can write 
 
105
            <literal>y(t)= coef* z(t) + sig*e(t) </literal> and the algorithm minimises 
 
106
            <literal>sum_{t=1}^N ( [y(t)- coef'z(t)]^2)</literal>
 
107
            where t0=max(max(r,s)+1,1))).
 
108
        </para>
 
109
    </refsection>
 
110
    <refsection>
 
111
        <title>Examples</title>
 
112
        <programlisting role="example"><![CDATA[ 
113
113
//-Ex1- Arma model : y(t) = 0.2*u(t-1)+0.01*e(t-1)
114
114
ny=1,nu=1,sig=0.01;
115
115
Arma=armac(1,[0,0.2],[0,1],ny,nu,sig)  //defining the above arma model
136
136
Arma1est=armax(2,-1,y,[]);
137
137
[A,B,D]=arma2p(Arma1est)
138
138
 ]]></programlisting>
139
 
  </refsection>
140
 
  <refsection role="see also">
141
 
    <title>See Also</title>
142
 
    <simplelist type="inline">
143
 
      <member>
144
 
        <link linkend="imrep2ss">imrep2ss</link>
145
 
      </member>
146
 
      <member>
147
 
        <link linkend="time_id">time_id</link>
148
 
      </member>
149
 
      <member>
150
 
        <link linkend="arl2">arl2</link>
151
 
      </member>
152
 
      <member>
153
 
        <link linkend="armax">armax</link>
154
 
      </member>
155
 
      <member>
156
 
        <link linkend="frep2tf">frep2tf</link>
157
 
      </member>
158
 
    </simplelist>
159
 
  </refsection>
 
139
    </refsection>
 
140
    <refsection role="see also">
 
141
        <title>See Also</title>
 
142
        <simplelist type="inline">
 
143
            <member>
 
144
                <link linkend="imrep2ss">imrep2ss</link>
 
145
            </member>
 
146
            <member>
 
147
                <link linkend="time_id">time_id</link>
 
148
            </member>
 
149
            <member>
 
150
                <link linkend="arl2">arl2</link>
 
151
            </member>
 
152
            <member>
 
153
                <link linkend="armax">armax</link>
 
154
            </member>
 
155
            <member>
 
156
                <link linkend="frep2tf">frep2tf</link>
 
157
            </member>
 
158
        </simplelist>
 
159
    </refsection>
160
160
</refentry>