DEADBAND US help 76/2576/7
Zhour MADINI-ZOUINE [Tue, 23 Nov 2010 16:45:29 +0000 (17:45 +0100)]
Change-Id: I524302716ccdd201805da0093a034f086d08ef88

13 files changed:
scilab/modules/xcos/Makefile.am
scilab/modules/xcos/Makefile.in
scilab/modules/xcos/examples/dead_zone.xcos [new file with mode: 0644]
scilab/modules/xcos/help/en_US/palettes/Continuous_pal/INTEGRAL_m.xml
scilab/modules/xcos/help/en_US/palettes/Discontinuities_pal/DEADBAND.xml
scilab/modules/xcos/help/examples/deadband_c.png [new file with mode: 0644]
scilab/modules/xcos/help/examples/deadband_d.png [new file with mode: 0644]
scilab/modules/xcos/help/examples/deadband_desc.png [new file with mode: 0644]
scilab/modules/xcos/help/examples/deadband_eq.gif [new file with mode: 0644]
scilab/modules/xcos/help/examples/deadband_eq1.gif [new file with mode: 0644]
scilab/modules/xcos/help/examples/deadband_eq2.gif [new file with mode: 0644]
scilab/modules/xcos/help/examples/deadband_screen.png [new file with mode: 0644]
scilab/modules/xcos/images/palettes/DEADBAND_modif.png [moved from scilab/modules/xcos/images/palettes/DEADBAND.png with 100% similarity]

index cd41d42..3381a77 100644 (file)
@@ -236,7 +236,7 @@ images/palettes/CUMSUM.png \
 images/palettes/CurrentSensor.png \
 images/palettes/CURV_f.png \
 images/palettes/CVS.png \
-images/palettes/DEADBAND.png \
+images/palettes/DEADBAND_modif.png \
 images/palettes/DEBUG_SCICOS.png \
 images/palettes/DELAY_f.png \
 images/palettes/DELAYV_f.png \
index 14700e7..666dc7a 100644 (file)
@@ -643,7 +643,7 @@ images/palettes/CUMSUM.png \
 images/palettes/CurrentSensor.png \
 images/palettes/CURV_f.png \
 images/palettes/CVS.png \
-images/palettes/DEADBAND.png \
+images/palettes/DEADBAND_modif.png \
 images/palettes/DEBUG_SCICOS.png \
 images/palettes/DELAY_f.png \
 images/palettes/DELAYV_f.png \
diff --git a/scilab/modules/xcos/examples/dead_zone.xcos b/scilab/modules/xcos/examples/dead_zone.xcos
new file mode 100644 (file)
index 0000000..77a5cd1
Binary files /dev/null and b/scilab/modules/xcos/examples/dead_zone.xcos differ
index a14bb31..77fa7f8 100644 (file)
         <para><emphasis role="bold">Ramine Nikoukhah</emphasis> INRIA</para>
       </listitem>
       <listitem>
-        <para><emphasis role="bold">Zhour Madini-Zouine</emphasis> INRIA</para>
+        <para><emphasis role="bold">Zhour Madini-Zouine</emphasis> DIGITEO</para>
       </listitem>
          
     </itemizedlist>
index 1a7ee83..e23c145 100644 (file)
  * 
  * See the file ./license.txt
  -->
-<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:id="DEADBAND">
+<refentry version="5.0-subset Scilab" xml:id="DEADBAND"
+          xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg"
+          xmlns:ns4="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
   <refnamediv>
     <refname>DEADBAND</refname>
+
     <refpurpose>Deadband</refpurpose>
   </refnamediv>
+
   <refsection>
     <title>Block Screenshot</title>
-    <para>
-      <inlinemediaobject>
+
+    <para><inlinemediaobject>
         <imageobject>
-          <imagedata fileref="../../../../images/palettes/DEADBAND.png" align="center" valign="middle"/>
+          <imagedata align="center"
+                     fileref="../../../../images/palettes/DEADBAND_modif.png"
+                     valign="middle" />
         </imageobject>
-      </inlinemediaobject>
-    </para>
+      </inlinemediaobject></para>
   </refsection>
+
   <refsection id="Contents_DEADBAND">
     <title>Contents</title>
+
     <itemizedlist>
       <listitem>
-        <para>
-          <link linkend="DEADBAND">Deadband</link>
-        </para>
+        <para><link linkend="DEADBAND">Deadband</link></para>
       </listitem>
+
       <listitem>
         <itemizedlist>
           <listitem>
-            <para>
-              <xref linkend="Palette_DEADBAND">Palette</xref>
-            </para>
+            <para><xref linkend="Palette_DEADBAND">Palette</xref></para>
           </listitem>
+
+          <listitem>
+            <para><xref
+            linkend="Description_DEADBAND">Description</xref></para>
+          </listitem>
+
           <listitem>
-            <para>
-              <xref linkend="Description_DEADBAND">Description</xref>
-            </para>
+            <para><xref linkend="Dialogbox_DEADBAND">Dialog box</xref></para>
           </listitem>
+
           <listitem>
-            <para>
-              <xref linkend="Dialogbox_DEADBAND">Dialog box</xref>
-            </para>
+            <para><xref linkend="Defaultproperties_DEADBAND">Default
+            properties</xref></para>
           </listitem>
+
           <listitem>
-            <para>
-              <xref linkend="Defaultproperties_DEADBAND">Default properties</xref>
-            </para>
+            <para><xref linkend="Example_DEADBAND">Deadband
+            Example</xref></para>
           </listitem>
+
           <listitem>
-            <para>
-              <xref linkend="Interfacingfunction_DEADBAND">Interfacing function</xref>
-            </para>
+            <para><xref linkend="Interfacingfunction_DEADBAND">Interfacing
+            function</xref></para>
           </listitem>
+
           <listitem>
-            <para>
-              <xref linkend="Computationalfunction_DEADBAND">Computational function</xref>
-            </para>
+            <para><xref linkend="Computationalfunction_DEADBAND">Computational
+            function</xref></para>
           </listitem>
+
           <listitem>
-            <para>
-              <xref linkend="Authors_DEADBAND">Authors</xref>
-            </para>
+            <para><xref linkend="Authors_DEADBAND">Authors</xref></para>
           </listitem>
         </itemizedlist>
       </listitem>
     </itemizedlist>
   </refsection>
+
   <refsection id="Palette_DEADBAND">
     <title>Palette</title>
+
     <itemizedlist>
       <listitem>
-        <para>
-          <link linkend="discontinuities_pal">discontinuities palette</link>
-        </para>
+        <para><link linkend="discontinuities_pal">discontinuities
+        palette</link></para>
       </listitem>
     </itemizedlist>
   </refsection>
+
   <refsection id="Description_DEADBAND">
     <title>Description</title>
-    <para>
-Provide a region of zero output
 
-</para>
+    <para>The Dead Band block provides a region of zero output.</para>
+
+    <para>It's a range of inputs for which the output remains unchanged.
+    Outside that range there is a linear relationship between the deadband
+    input u(k) and the dead band output v(k).</para>
+
+    <para>Below is shown a graph of a particular deadband:</para>
+
+    <para><inlinemediaobject>
+        <imageobject>
+          <imagedata align="center"
+                     fileref="../../../examples/deadband_desc.png"
+                     valign="middle" />
+        </imageobject>
+      </inlinemediaobject></para>
+
+    <para>It is defined by:</para>
+
+    <para><inlinemediaobject>
+        <imageobject>
+          <imagedata align="center"
+                     fileref="../../../examples/deadband_eq.gif"
+                     valign="middle" />
+        </imageobject>
+      </inlinemediaobject></para>
+
+    <para>Where <para>
+        <inlinemediaobject>
+          <imageobject>
+            <imagedata align="center"
+                       fileref="../../../examples/deadband_eq1.gif"
+                       valign="middle" />
+          </imageobject>
+        </inlinemediaobject>
+      </para></para>
+
+    <para>When the input u(k) is between Cs and CE, the output v(k) is zero.
+    When the input is greater than or equal to the upper limit CE, the output
+    is the input minus the upper limit. When the input is less than or equal
+    to the lower limit Cs, the output is the input minus the lower
+    limit.</para>
   </refsection>
+
   <refsection id="Dialogbox_DEADBAND">
     <title>Dialog box</title>
-    <para>
-      <inlinemediaobject>
+
+    <para><inlinemediaobject>
         <imageobject>
-          <imagedata fileref="../../../../images/gui/DEADBAND_gui.gif" align="center" valign="middle"/>
+          <imagedata align="center"
+                     fileref="../../../examples/deadband_screen.png"
+                     valign="middle" />
         </imageobject>
-      </inlinemediaobject>
-    </para>
-    <para>
+      </inlinemediaobject></para>
+
+    <para></para>
 
-</para>
     <itemizedlist>
       <listitem>
-        <para>
-          <emphasis role="bold">End of dead band</emphasis>
-        </para>
-        <para> The upper limit of the dead band.</para>
-        <para> Properties : Type 'vec' of size 1 </para>
+        <para><emphasis role="bold">End of dead band</emphasis></para>
+
+        <para>The upper limit of the dead band.</para>
+
+        <para>Properties : Type 'vec' of size 1</para>
       </listitem>
+
       <listitem>
-        <para>
-          <emphasis role="bold">Start of dead band</emphasis>
-        </para>
-        <para> The lower limit of the dead band.</para>
-        <para> Properties : Type 'vec' of size 1 </para>
+        <para><emphasis role="bold">Start of dead band</emphasis></para>
+
+        <para>The lower limit of the dead band.</para>
+
+        <para>Properties : Type 'vec' of size 1</para>
       </listitem>
+
       <listitem>
-        <para>
-          <emphasis role="bold">zero crossing </emphasis>
-        </para>
-        <para> Select to enable zero crossing detection to detect when the limits are reached.</para>
-        <para> Properties : Type 'vec' of size 1</para>
+        <para><emphasis role="bold">zero crossing</emphasis></para>
+
+        <para>Select to enable zero crossing detection to detect when the
+        limits are reached.</para>
+
+        <para>Properties : Type 'vec' of size 1</para>
       </listitem>
     </itemizedlist>
   </refsection>
+
   <refsection id="Defaultproperties_DEADBAND">
     <title>Default properties</title>
+
     <itemizedlist>
       <listitem>
         <para><emphasis role="bold">always active:</emphasis> no</para>
       </listitem>
+
       <listitem>
         <para><emphasis role="bold">direct-feedthrough:</emphasis> yes</para>
       </listitem>
+
       <listitem>
         <para><emphasis role="bold">zero-crossing:</emphasis> yes</para>
       </listitem>
+
       <listitem>
         <para><emphasis role="bold">mode:</emphasis> yes</para>
       </listitem>
+
       <listitem>
-        <para>
-          <emphasis role="bold">regular inputs:</emphasis>
-        </para>
-        <para>
-          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
-        </para>
+        <para><emphasis role="bold">regular inputs:</emphasis></para>
+
+        <para><emphasis role="bold">- port 1 : size [1,1] / type
+        1</emphasis></para>
       </listitem>
+
       <listitem>
-        <para>
-          <emphasis role="bold">regular outputs:</emphasis>
-        </para>
-        <para>
-          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
-        </para>
+        <para><emphasis role="bold">regular outputs:</emphasis></para>
+
+        <para><emphasis role="bold">- port 1 : size [1,1] / type
+        1</emphasis></para>
       </listitem>
+
       <listitem>
-        <para><emphasis role="bold">number/sizes of activation inputs:</emphasis> 0</para>
+        <para><emphasis role="bold">number/sizes of activation
+        inputs:</emphasis> 0</para>
       </listitem>
+
       <listitem>
-        <para><emphasis role="bold">number/sizes of activation outputs:</emphasis> 0</para>
+        <para><emphasis role="bold">number/sizes of activation
+        outputs:</emphasis> 0</para>
       </listitem>
+
       <listitem>
-        <para><emphasis role="bold">continuous-time state:</emphasis> no</para>
+        <para><emphasis role="bold">continuous-time state:</emphasis>
+        no</para>
       </listitem>
+
       <listitem>
         <para><emphasis role="bold">discrete-time state:</emphasis> no</para>
       </listitem>
+
       <listitem>
-        <para><emphasis role="bold">object discrete-time state:</emphasis> no</para>
+        <para><emphasis role="bold">object discrete-time state:</emphasis>
+        no</para>
       </listitem>
+
       <listitem>
-        <para>
-          <emphasis role="bold">name of computational function:</emphasis>
-          <emphasis role="italic">deadband</emphasis>
-        </para>
+        <para><emphasis role="bold">name of computational function:</emphasis>
+        <emphasis role="italic">deadband</emphasis></para>
       </listitem>
     </itemizedlist>
   </refsection>
+
+  <refsection id="Example_DEADBAND">
+    <title>Deadband Example</title>
+
+    <para>The following is an example of a system with deadband.</para>
+
+    <para><inlinemediaobject>
+        <imageobject>
+          <imagedata align="center" fileref="../../../examples/deadband_d.png"
+                     valign="middle" />
+        </imageobject>
+      </inlinemediaobject></para>
+
+    <para>The input is a sine wave. The magnitude is set to 2, the frequency
+    to 1.25 and the phase to 0. The Deadband block has the following
+    parameters:</para>
+
+    <para><inlinemediaobject>
+        <imageobject>
+          <imagedata align="center"
+                     fileref="../../../examples/deadband_eq2.gif"
+                     valign="middle" />
+        </imageobject>
+      </inlinemediaobject></para>
+
+    <para>This plot shows the effect of the dead band on the sine wave.</para>
+
+    <para><inlinemediaobject>
+        <imageobject>
+          <imagedata align="center" fileref="../../../examples/deadband_c.png"
+                     valign="middle" />
+        </imageobject>
+      </inlinemediaobject></para>
+  </refsection>
+
   <refsection id="Interfacingfunction_DEADBAND">
     <title>Interfacing function</title>
+
     <itemizedlist>
       <listitem>
-        <para> SCI/modules/scicos_blocks/macros/Misc/DEADBAND.sci</para>
+        <para>SCI/modules/scicos_blocks/macros/Misc/DEADBAND.sci</para>
       </listitem>
     </itemizedlist>
   </refsection>
+
   <refsection id="Computationalfunction_DEADBAND">
     <title>Computational function</title>
+
     <itemizedlist>
       <listitem>
-        <para> SCI/modules/scicos_blocks/src/c/deadband.c (Type 4)</para>
+        <para>SCI/modules/scicos_blocks/src/c/deadband.c (Type 4)</para>
       </listitem>
     </itemizedlist>
   </refsection>
+
   <refsection id="Authors_DEADBAND">
     <title>Authors</title>
+
     <para><emphasis role="bold">Ramine Nikoukhah</emphasis> - INRIA</para>
+
+    <para><emphasis role="bold">Zhour Madini-Zouine</emphasis> -
+    DIGITEO</para>
+
+    <para></para>
   </refsection>
 </refentry>
diff --git a/scilab/modules/xcos/help/examples/deadband_c.png b/scilab/modules/xcos/help/examples/deadband_c.png
new file mode 100644 (file)
index 0000000..cafc70b
Binary files /dev/null and b/scilab/modules/xcos/help/examples/deadband_c.png differ
diff --git a/scilab/modules/xcos/help/examples/deadband_d.png b/scilab/modules/xcos/help/examples/deadband_d.png
new file mode 100644 (file)
index 0000000..e19e914
Binary files /dev/null and b/scilab/modules/xcos/help/examples/deadband_d.png differ
diff --git a/scilab/modules/xcos/help/examples/deadband_desc.png b/scilab/modules/xcos/help/examples/deadband_desc.png
new file mode 100644 (file)
index 0000000..9c99f22
Binary files /dev/null and b/scilab/modules/xcos/help/examples/deadband_desc.png differ
diff --git a/scilab/modules/xcos/help/examples/deadband_eq.gif b/scilab/modules/xcos/help/examples/deadband_eq.gif
new file mode 100644 (file)
index 0000000..4b09d38
Binary files /dev/null and b/scilab/modules/xcos/help/examples/deadband_eq.gif differ
diff --git a/scilab/modules/xcos/help/examples/deadband_eq1.gif b/scilab/modules/xcos/help/examples/deadband_eq1.gif
new file mode 100644 (file)
index 0000000..b2d2e4e
Binary files /dev/null and b/scilab/modules/xcos/help/examples/deadband_eq1.gif differ
diff --git a/scilab/modules/xcos/help/examples/deadband_eq2.gif b/scilab/modules/xcos/help/examples/deadband_eq2.gif
new file mode 100644 (file)
index 0000000..a70522d
Binary files /dev/null and b/scilab/modules/xcos/help/examples/deadband_eq2.gif differ
diff --git a/scilab/modules/xcos/help/examples/deadband_screen.png b/scilab/modules/xcos/help/examples/deadband_screen.png
new file mode 100644 (file)
index 0000000..091b968
Binary files /dev/null and b/scilab/modules/xcos/help/examples/deadband_screen.png differ