DEADBAND US help
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Discontinuities_pal / DEADBAND.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <refentry version="5.0-subset Scilab" xml:id="DEADBAND"
25           xmlns="http://docbook.org/ns/docbook"
26           xmlns:xlink="http://www.w3.org/1999/xlink"
27           xmlns:svg="http://www.w3.org/2000/svg"
28           xmlns:ns4="http://www.w3.org/1999/xhtml"
29           xmlns:mml="http://www.w3.org/1998/Math/MathML"
30           xmlns:db="http://docbook.org/ns/docbook">
31   <refnamediv>
32     <refname>DEADBAND</refname>
33
34     <refpurpose>Deadband</refpurpose>
35   </refnamediv>
36
37   <refsection>
38     <title>Block Screenshot</title>
39
40     <para><inlinemediaobject>
41         <imageobject>
42           <imagedata align="center"
43                      fileref="../../../../images/palettes/DEADBAND_modif.png"
44                      valign="middle" />
45         </imageobject>
46       </inlinemediaobject></para>
47   </refsection>
48
49   <refsection id="Contents_DEADBAND">
50     <title>Contents</title>
51
52     <itemizedlist>
53       <listitem>
54         <para><link linkend="DEADBAND">Deadband</link></para>
55       </listitem>
56
57       <listitem>
58         <itemizedlist>
59           <listitem>
60             <para><xref linkend="Palette_DEADBAND">Palette</xref></para>
61           </listitem>
62
63           <listitem>
64             <para><xref
65             linkend="Description_DEADBAND">Description</xref></para>
66           </listitem>
67
68           <listitem>
69             <para><xref linkend="Dialogbox_DEADBAND">Dialog box</xref></para>
70           </listitem>
71
72           <listitem>
73             <para><xref linkend="Defaultproperties_DEADBAND">Default
74             properties</xref></para>
75           </listitem>
76
77           <listitem>
78             <para><xref linkend="Example_DEADBAND">Deadband
79             Example</xref></para>
80           </listitem>
81
82           <listitem>
83             <para><xref linkend="Interfacingfunction_DEADBAND">Interfacing
84             function</xref></para>
85           </listitem>
86
87           <listitem>
88             <para><xref linkend="Computationalfunction_DEADBAND">Computational
89             function</xref></para>
90           </listitem>
91
92           <listitem>
93             <para><xref linkend="Authors_DEADBAND">Authors</xref></para>
94           </listitem>
95         </itemizedlist>
96       </listitem>
97     </itemizedlist>
98   </refsection>
99
100   <refsection id="Palette_DEADBAND">
101     <title>Palette</title>
102
103     <itemizedlist>
104       <listitem>
105         <para><link linkend="discontinuities_pal">discontinuities
106         palette</link></para>
107       </listitem>
108     </itemizedlist>
109   </refsection>
110
111   <refsection id="Description_DEADBAND">
112     <title>Description</title>
113
114     <para>The Dead Band block provides a region of zero output.</para>
115
116     <para>It's a range of inputs for which the output remains unchanged.
117     Outside that range there is a linear relationship between the deadband
118     input u(k) and the dead band output v(k).</para>
119
120     <para>Below is shown a graph of a particular deadband:</para>
121
122     <para><inlinemediaobject>
123         <imageobject>
124           <imagedata align="center"
125                      fileref="../../../examples/deadband_desc.png"
126                      valign="middle" />
127         </imageobject>
128       </inlinemediaobject></para>
129
130     <para>It is defined by:</para>
131
132     <para><inlinemediaobject>
133         <imageobject>
134           <imagedata align="center"
135                      fileref="../../../examples/deadband_eq.gif"
136                      valign="middle" />
137         </imageobject>
138       </inlinemediaobject></para>
139
140     <para>Where <para>
141         <inlinemediaobject>
142           <imageobject>
143             <imagedata align="center"
144                        fileref="../../../examples/deadband_eq1.gif"
145                        valign="middle" />
146           </imageobject>
147         </inlinemediaobject>
148       </para></para>
149
150     <para>When the input u(k) is between Cs and CE, the output v(k) is zero.
151     When the input is greater than or equal to the upper limit CE, the output
152     is the input minus the upper limit. When the input is less than or equal
153     to the lower limit Cs, the output is the input minus the lower
154     limit.</para>
155   </refsection>
156
157   <refsection id="Dialogbox_DEADBAND">
158     <title>Dialog box</title>
159
160     <para><inlinemediaobject>
161         <imageobject>
162           <imagedata align="center"
163                      fileref="../../../examples/deadband_screen.png"
164                      valign="middle" />
165         </imageobject>
166       </inlinemediaobject></para>
167
168     <para></para>
169
170     <itemizedlist>
171       <listitem>
172         <para><emphasis role="bold">End of dead band</emphasis></para>
173
174         <para>The upper limit of the dead band.</para>
175
176         <para>Properties : Type 'vec' of size 1</para>
177       </listitem>
178
179       <listitem>
180         <para><emphasis role="bold">Start of dead band</emphasis></para>
181
182         <para>The lower limit of the dead band.</para>
183
184         <para>Properties : Type 'vec' of size 1</para>
185       </listitem>
186
187       <listitem>
188         <para><emphasis role="bold">zero crossing</emphasis></para>
189
190         <para>Select to enable zero crossing detection to detect when the
191         limits are reached.</para>
192
193         <para>Properties : Type 'vec' of size 1</para>
194       </listitem>
195     </itemizedlist>
196   </refsection>
197
198   <refsection id="Defaultproperties_DEADBAND">
199     <title>Default properties</title>
200
201     <itemizedlist>
202       <listitem>
203         <para><emphasis role="bold">always active:</emphasis> no</para>
204       </listitem>
205
206       <listitem>
207         <para><emphasis role="bold">direct-feedthrough:</emphasis> yes</para>
208       </listitem>
209
210       <listitem>
211         <para><emphasis role="bold">zero-crossing:</emphasis> yes</para>
212       </listitem>
213
214       <listitem>
215         <para><emphasis role="bold">mode:</emphasis> yes</para>
216       </listitem>
217
218       <listitem>
219         <para><emphasis role="bold">regular inputs:</emphasis></para>
220
221         <para><emphasis role="bold">- port 1 : size [1,1] / type
222         1</emphasis></para>
223       </listitem>
224
225       <listitem>
226         <para><emphasis role="bold">regular outputs:</emphasis></para>
227
228         <para><emphasis role="bold">- port 1 : size [1,1] / type
229         1</emphasis></para>
230       </listitem>
231
232       <listitem>
233         <para><emphasis role="bold">number/sizes of activation
234         inputs:</emphasis> 0</para>
235       </listitem>
236
237       <listitem>
238         <para><emphasis role="bold">number/sizes of activation
239         outputs:</emphasis> 0</para>
240       </listitem>
241
242       <listitem>
243         <para><emphasis role="bold">continuous-time state:</emphasis>
244         no</para>
245       </listitem>
246
247       <listitem>
248         <para><emphasis role="bold">discrete-time state:</emphasis> no</para>
249       </listitem>
250
251       <listitem>
252         <para><emphasis role="bold">object discrete-time state:</emphasis>
253         no</para>
254       </listitem>
255
256       <listitem>
257         <para><emphasis role="bold">name of computational function:</emphasis>
258         <emphasis role="italic">deadband</emphasis></para>
259       </listitem>
260     </itemizedlist>
261   </refsection>
262
263   <refsection id="Example_DEADBAND">
264     <title>Deadband Example</title>
265
266     <para>The following is an example of a system with deadband.</para>
267
268     <para><inlinemediaobject>
269         <imageobject>
270           <imagedata align="center" fileref="../../../examples/deadband_d.png"
271                      valign="middle" />
272         </imageobject>
273       </inlinemediaobject></para>
274
275     <para>The input is a sine wave. The magnitude is set to 2, the frequency
276     to 1.25 and the phase to 0. The Deadband block has the following
277     parameters:</para>
278
279     <para><inlinemediaobject>
280         <imageobject>
281           <imagedata align="center"
282                      fileref="../../../examples/deadband_eq2.gif"
283                      valign="middle" />
284         </imageobject>
285       </inlinemediaobject></para>
286
287     <para>This plot shows the effect of the dead band on the sine wave.</para>
288
289     <para><inlinemediaobject>
290         <imageobject>
291           <imagedata align="center" fileref="../../../examples/deadband_c.png"
292                      valign="middle" />
293         </imageobject>
294       </inlinemediaobject></para>
295   </refsection>
296
297   <refsection id="Interfacingfunction_DEADBAND">
298     <title>Interfacing function</title>
299
300     <itemizedlist>
301       <listitem>
302         <para>SCI/modules/scicos_blocks/macros/Misc/DEADBAND.sci</para>
303       </listitem>
304     </itemizedlist>
305   </refsection>
306
307   <refsection id="Computationalfunction_DEADBAND">
308     <title>Computational function</title>
309
310     <itemizedlist>
311       <listitem>
312         <para>SCI/modules/scicos_blocks/src/c/deadband.c (Type 4)</para>
313       </listitem>
314     </itemizedlist>
315   </refsection>
316
317   <refsection id="Authors_DEADBAND">
318     <title>Authors</title>
319
320     <para><emphasis role="bold">Ramine Nikoukhah</emphasis> - INRIA</para>
321
322     <para><emphasis role="bold">Zhour Madini-Zouine</emphasis> -
323     DIGITEO</para>
324
325     <para></para>
326   </refsection>
327 </refentry>