Help check: validate the help files on compilation against a derivated docbook schema
[scilab.git] / scilab / modules / elementary_functions / help / en_US / signalprocessing / sysconv.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="sysconv" xml:lang="en">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>sysconv</refname>
19     <refpurpose>system conversion</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>[s1,s2]=sysconv(s1,s2)</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Arguments</title>
27     <variablelist>
28       <varlistentry>
29         <term>s1,s2</term>
30         <listitem>
31           <para>list (linear <literal>syslin</literal> systems)</para>
32         </listitem>
33       </varlistentry>
34     </variablelist>
35   </refsection>
36   <refsection>
37     <title>Description</title>
38     <para>Converts <literal>s1</literal> and <literal>s2</literal> into common
39     representation in order that system interconnexion operations can be
40     applied. Utility function for experts. The conversion rules in given in
41     the following table.</para>
42     <variablelist>
43       <varlistentry>
44         <term>"c"</term>
45         <listitem>
46           <para>continuous time system</para>
47         </listitem>
48       </varlistentry>
49       <varlistentry>
50         <term>"d"</term>
51         <listitem>
52           <para>discrete time system</para>
53         </listitem>
54       </varlistentry>
55       <varlistentry>
56         <term>n</term>
57         <listitem>
58           <para>sampled system with sampling period n</para>
59         </listitem>
60       </varlistentry>
61       <varlistentry>
62         <term>[]</term>
63         <listitem>
64           <para>system with undefined time domain For mixed systems
65           <literal>s1</literal> and <literal>s2</literal> are put in
66           state-space representation.</para>
67         </listitem>
68       </varlistentry>
69     </variablelist>
70     <programlisting><![CDATA[ 
71  s1\s2 |    "c"     |     "d"     |      n2        |     []     |
72  ---------------------------------------------------------------
73  "c"   | nothing    |uncompatible | c2e(s1,n2)     |  c(s2)     |
74  ---------------------------------------------------------------
75  "d"   |uncompatible| nothing     | e(s1,n2)       |  d(s2)     |
76  ---------------------------------------------------------------
77  n1    | c2e(s2,n1) | e(s2,n1)    | n1<>n2 uncomp  |  e(s2,n1)  |
78        |            |             | n1=n2  nothing |            |
79  ---------------------------------------------------------------
80  []    | c(s1)      | d(s1)       | e(s1,n2)       |  nothing   |
81  ---------------------------------------------------------------
82   ]]></programlisting>
83     <para>With the following meaning:</para>
84     <variablelist>
85       <varlistentry>
86         <term>n1,n2</term>
87         <listitem>
88           <para>sampling period</para>
89         </listitem>
90       </varlistentry>
91       <varlistentry>
92         <term>c2e(s,n)</term>
93         <listitem>
94           <para>the continuous-time system s is transformed into a sampled
95           system with sampling period n.</para>
96         </listitem>
97       </varlistentry>
98       <varlistentry>
99         <term>c(s)</term>
100         <listitem>
101           <para>conversion to continuous (time domain is
102           <literal>"c"</literal>)</para>
103         </listitem>
104       </varlistentry>
105       <varlistentry>
106         <term>d(s)</term>
107         <listitem>
108           <para>conversion to discrete (time domain is
109           <literal>"d"</literal>)</para>
110         </listitem>
111       </varlistentry>
112       <varlistentry>
113         <term>e(s,n)</term>
114         <listitem>
115           <para>conversion to samples system with period
116           <literal>n</literal></para>
117         </listitem>
118       </varlistentry>
119     </variablelist>
120   </refsection>
121   <refsection>
122     <title>Examples</title>
123     <programlisting role="example"><![CDATA[ 
124 s1=ssrand(1,1,2);
125 s2=ss2tf(s1);
126 [s1,s2]=sysconv(s1,s2);
127  ]]></programlisting>
128   </refsection>
129   <refsection role="see also">
130     <title>See Also</title>
131     <simplelist type="inline">
132       <member>
133         <link linkend="syslin">syslin</link>
134       </member>
135       <member>
136         <link linkend="ss2tf">ss2tf</link>
137       </member>
138       <member>
139         <link linkend="tf2ss">tf2ss</link>
140       </member>
141     </simplelist>
142   </refsection>
143 </refentry>