← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/palettes/Discontinuities_pal/SATURATION.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/xcos/help/en_US/palettes/Discontinuities_pal/SATURATION.xml
22
22
 * See the file ./license.txt
23
23
 -->
24
24
<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="SATURATION">
25
 
  <refnamediv>
26
 
    <refname>SATURATION</refname>
27
 
    <refpurpose>Saturation</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/SATURATION.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_SATURATION">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="SATURATION">Saturation</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_SATURATION">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_SATURATION">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_SATURATION">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_SATURATION">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_SATURATION">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_SATURATION">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
        </itemizedlist>
80
 
      </listitem>
81
 
    </itemizedlist>
82
 
  </refsection>
83
 
  <refsection id="Palette_SATURATION">
84
 
    <title>Palette</title>
85
 
    <itemizedlist>
86
 
      <listitem>
87
 
        <para>
88
 
          <link linkend="discontinuities_pal">discontinuities palette</link>
89
 
        </para>
90
 
      </listitem>
91
 
    </itemizedlist>
92
 
  </refsection>
93
 
  <refsection id="Description_SATURATION">
94
 
    <title>Description</title>
95
 
    <para>
96
 
      The Saturation block imposes upper and lower bounds on a signal. When
97
 
      the input signal is within the range specified by the Lower limit and
98
 
      Upper limit parameters, the input signal passes through
99
 
      unchanged. When the input signal is outside these bounds, the signal
100
 
      is clipped to the upper or lower bound. When the Lower limit and Upper
101
 
      limit parameters are set to the same value, the block outputs that
102
 
      value. 
103
 
      
104
 
    </para>
105
 
  </refsection>
106
 
  <refsection id="Dialogbox_SATURATION">
107
 
    <title>Dialog box</title>
108
 
    <para>
109
 
      <inlinemediaobject>
110
 
        <imageobject>
111
 
          <imagedata fileref="../../../../images/gui/SATURATION_gui.gif" align="center" valign="middle"/>
112
 
        </imageobject>
113
 
      </inlinemediaobject>
114
 
    </para>
115
 
    <para>
116
 
      
117
 
    </para>
118
 
    <itemizedlist>
119
 
      <listitem>
120
 
        <para>
121
 
          <emphasis role="bold">Upper limit</emphasis>
122
 
        </para>
123
 
        <para> Specify the upper bound on the input signal. When the input signal to the Saturation block is above this value, the output of the block is clipped to this value.</para>
124
 
        <para> Properties : Type 'vec' of size 1 </para>
125
 
      </listitem>
126
 
      <listitem>
127
 
        <para>
128
 
          <emphasis role="bold">Lower limit</emphasis>
129
 
        </para>
130
 
        <para> Specify the lower bound on the input signal. When the input signal to the Saturation block is below this value, the output of the block is clipped to this value.</para>
131
 
        <para> Properties : Type 'vec' of size 1 </para>
132
 
      </listitem>
133
 
      <listitem>
134
 
        <para>
135
 
          <emphasis role="bold">zero crossing </emphasis>
136
 
        </para>
137
 
        <para> Select to enable zero crossing detection.</para>
138
 
        <para> Properties : Type 'vec' of size 1</para>
139
 
      </listitem>
140
 
    </itemizedlist>
141
 
  </refsection>
142
 
  <refsection id="Defaultproperties_SATURATION">
143
 
    <title>Default properties</title>
144
 
    <itemizedlist>
145
 
      <listitem>
146
 
        <para>
147
 
          <emphasis role="bold">always active:</emphasis> no
148
 
        </para>
149
 
      </listitem>
150
 
      <listitem>
151
 
        <para>
152
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
153
 
        </para>
154
 
      </listitem>
155
 
      <listitem>
156
 
        <para>
157
 
          <emphasis role="bold">zero-crossing:</emphasis> yes
158
 
        </para>
159
 
      </listitem>
160
 
      <listitem>
161
 
        <para>
162
 
          <emphasis role="bold">mode:</emphasis> yes
163
 
        </para>
164
 
      </listitem>
165
 
      <listitem>
166
 
        <para>
167
 
          <emphasis role="bold">regular inputs:</emphasis>
168
 
        </para>
169
 
        <para>
170
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
171
 
        </para>
172
 
      </listitem>
173
 
      <listitem>
174
 
        <para>
175
 
          <emphasis role="bold">regular outputs:</emphasis>
176
 
        </para>
177
 
        <para>
178
 
          <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
179
 
        </para>
180
 
      </listitem>
181
 
      <listitem>
182
 
        <para>
183
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
184
 
        </para>
185
 
      </listitem>
186
 
      <listitem>
187
 
        <para>
188
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
189
 
        </para>
190
 
      </listitem>
191
 
      <listitem>
192
 
        <para>
193
 
          <emphasis role="bold">continuous-time state:</emphasis> no
194
 
        </para>
195
 
      </listitem>
196
 
      <listitem>
197
 
        <para>
198
 
          <emphasis role="bold">discrete-time state:</emphasis> no
199
 
        </para>
200
 
      </listitem>
201
 
      <listitem>
202
 
        <para>
203
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
204
 
        </para>
205
 
      </listitem>
206
 
      <listitem>
207
 
        <para>
208
 
          <emphasis role="bold">name of computational function:</emphasis>
209
 
          <emphasis role="italic">satur</emphasis>
210
 
        </para>
211
 
      </listitem>
212
 
    </itemizedlist>
213
 
  </refsection>
214
 
  <refsection id="Interfacingfunction_SATURATION">
215
 
    <title>Interfacing function</title>
216
 
    <itemizedlist>
217
 
      <listitem>
218
 
        <para> SCI/modules/scicos_blocks/macros/NonLinear/SATURATION.sci</para>
219
 
      </listitem>
220
 
    </itemizedlist>
221
 
  </refsection>
222
 
  <refsection id="Computationalfunction_SATURATION">
223
 
    <title>Computational function</title>
224
 
    <itemizedlist>
225
 
      <listitem>
226
 
        <para> SCI/modules/scicos_blocks/src/c/satur.c (Type 4)</para>
227
 
      </listitem>
228
 
    </itemizedlist>
229
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>SATURATION</refname>
 
27
        <refpurpose>Saturation</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/SATURATION.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_SATURATION">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="SATURATION">Saturation</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_SATURATION">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_SATURATION">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_SATURATION">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_SATURATION">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_SATURATION">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_SATURATION">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                </itemizedlist>
 
80
            </listitem>
 
81
        </itemizedlist>
 
82
    </refsection>
 
83
    <refsection id="Palette_SATURATION">
 
84
        <title>Palette</title>
 
85
        <itemizedlist>
 
86
            <listitem>
 
87
                <para>
 
88
                    <link linkend="discontinuities_pal">discontinuities palette</link>
 
89
                </para>
 
90
            </listitem>
 
91
        </itemizedlist>
 
92
    </refsection>
 
93
    <refsection id="Description_SATURATION">
 
94
        <title>Description</title>
 
95
        <para>
 
96
            The Saturation block imposes upper and lower bounds on a signal. When
 
97
            the input signal is within the range specified by the Lower limit and
 
98
            Upper limit parameters, the input signal passes through
 
99
            unchanged. When the input signal is outside these bounds, the signal
 
100
            is clipped to the upper or lower bound. When the Lower limit and Upper
 
101
            limit parameters are set to the same value, the block outputs that
 
102
            value. 
 
103
            
 
104
        </para>
 
105
    </refsection>
 
106
    <refsection id="Dialogbox_SATURATION">
 
107
        <title>Dialog box</title>
 
108
        <para>
 
109
            <inlinemediaobject>
 
110
                <imageobject>
 
111
                    <imagedata fileref="../../../../images/gui/SATURATION_gui.gif" align="center" valign="middle"/>
 
112
                </imageobject>
 
113
            </inlinemediaobject>
 
114
        </para>
 
115
        <para>
 
116
            
 
117
        </para>
 
118
        <itemizedlist>
 
119
            <listitem>
 
120
                <para>
 
121
                    <emphasis role="bold">Upper limit</emphasis>
 
122
                </para>
 
123
                <para> Specify the upper bound on the input signal. When the input signal to the Saturation block is above this value, the output of the block is clipped to this value.</para>
 
124
                <para> Properties : Type 'vec' of size 1 </para>
 
125
            </listitem>
 
126
            <listitem>
 
127
                <para>
 
128
                    <emphasis role="bold">Lower limit</emphasis>
 
129
                </para>
 
130
                <para> Specify the lower bound on the input signal. When the input signal to the Saturation block is below this value, the output of the block is clipped to this value.</para>
 
131
                <para> Properties : Type 'vec' of size 1 </para>
 
132
            </listitem>
 
133
            <listitem>
 
134
                <para>
 
135
                    <emphasis role="bold">zero crossing </emphasis>
 
136
                </para>
 
137
                <para> Select to enable zero crossing detection.</para>
 
138
                <para> Properties : Type 'vec' of size 1</para>
 
139
            </listitem>
 
140
        </itemizedlist>
 
141
    </refsection>
 
142
    <refsection id="Defaultproperties_SATURATION">
 
143
        <title>Default properties</title>
 
144
        <itemizedlist>
 
145
            <listitem>
 
146
                <para>
 
147
                    <emphasis role="bold">always active:</emphasis> no
 
148
                </para>
 
149
            </listitem>
 
150
            <listitem>
 
151
                <para>
 
152
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
153
                </para>
 
154
            </listitem>
 
155
            <listitem>
 
156
                <para>
 
157
                    <emphasis role="bold">zero-crossing:</emphasis> yes
 
158
                </para>
 
159
            </listitem>
 
160
            <listitem>
 
161
                <para>
 
162
                    <emphasis role="bold">mode:</emphasis> yes
 
163
                </para>
 
164
            </listitem>
 
165
            <listitem>
 
166
                <para>
 
167
                    <emphasis role="bold">regular inputs:</emphasis>
 
168
                </para>
 
169
                <para>
 
170
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
171
                </para>
 
172
            </listitem>
 
173
            <listitem>
 
174
                <para>
 
175
                    <emphasis role="bold">regular outputs:</emphasis>
 
176
                </para>
 
177
                <para>
 
178
                    <emphasis role="bold">- port 1 : size [1,1] / type 1</emphasis>
 
179
                </para>
 
180
            </listitem>
 
181
            <listitem>
 
182
                <para>
 
183
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 
184
                </para>
 
185
            </listitem>
 
186
            <listitem>
 
187
                <para>
 
188
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
189
                </para>
 
190
            </listitem>
 
191
            <listitem>
 
192
                <para>
 
193
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
194
                </para>
 
195
            </listitem>
 
196
            <listitem>
 
197
                <para>
 
198
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
199
                </para>
 
200
            </listitem>
 
201
            <listitem>
 
202
                <para>
 
203
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
204
                </para>
 
205
            </listitem>
 
206
            <listitem>
 
207
                <para>
 
208
                    <emphasis role="bold">name of computational function:</emphasis>
 
209
                    <emphasis role="italic">satur</emphasis>
 
210
                </para>
 
211
            </listitem>
 
212
        </itemizedlist>
 
213
    </refsection>
 
214
    <refsection id="Interfacingfunction_SATURATION">
 
215
        <title>Interfacing function</title>
 
216
        <itemizedlist>
 
217
            <listitem>
 
218
                <para> SCI/modules/scicos_blocks/macros/NonLinear/SATURATION.sci</para>
 
219
            </listitem>
 
220
        </itemizedlist>
 
221
    </refsection>
 
222
    <refsection id="Computationalfunction_SATURATION">
 
223
        <title>Computational function</title>
 
224
        <itemizedlist>
 
225
            <listitem>
 
226
                <para> SCI/modules/scicos_blocks/src/c/satur.c (Type 4)</para>
 
227
            </listitem>
 
228
        </itemizedlist>
 
229
    </refsection>
230
230
</refentry>