← 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/Sources_pal/PULSE_SC.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/Sources_pal/PULSE_SC.xml
23
23
 * See the file ./license.txt
24
24
 -->
25
25
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ns5="http://www.w3.org/1999/xhtml" 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="PULSE_SC" xml:lang="en_US">
26
 
  <refnamediv>
27
 
    <refname>PULSE_SC</refname>
28
 
    <refpurpose>Pulse Generator</refpurpose>
29
 
  </refnamediv>
30
 
  <refsection>
31
 
    <title>Block Screenshot</title>
32
 
    <para>
33
 
      <inlinemediaobject>
34
 
        <imageobject>
35
 
          <imagedata fileref="../../../../images/palettes/PULSE_SC.png" align="center" valign="middle"/>
36
 
        </imageobject>
37
 
      </inlinemediaobject>
38
 
    </para>
39
 
  </refsection>
40
 
  <refsection id="Contents_PULSE_SC">
41
 
    <title>Contents</title>
42
 
    <itemizedlist>
43
 
      <listitem>
44
 
        <para>
45
 
          <link linkend="PULSE_SC">Pulse Generator</link>
46
 
        </para>
47
 
      </listitem>
48
 
      <listitem>
49
 
        <itemizedlist>
50
 
          <listitem>
51
 
            <para>
52
 
              <xref linkend="Palette_PULSE_SC">Palette</xref>
53
 
            </para>
54
 
          </listitem>
55
 
          <listitem>
56
 
            <para>
57
 
              <xref linkend="Description_PULSE_SC">Description</xref>
58
 
            </para>
59
 
          </listitem>
60
 
          <listitem>
61
 
            <para>
62
 
              <xref linkend="Dialogbox_PULSE_SC">Dialog box</xref>
63
 
            </para>
64
 
          </listitem>
65
 
          <listitem>
66
 
            <para>
67
 
              <xref linkend="Defaultproperties_PULSE_SC">Default properties</xref>
68
 
            </para>
69
 
          </listitem>
70
 
          <listitem>
71
 
            <para>
72
 
              <xref linkend="Interfacingfunction_PULSE_SC">Interfacing function</xref>
73
 
            </para>
74
 
          </listitem>
75
 
          <listitem>
76
 
            <para>
77
 
              <xref linkend="Seealso_PULSE_SC">See also</xref>
78
 
            </para>
79
 
          </listitem>
80
 
        </itemizedlist>
81
 
      </listitem>
82
 
    </itemizedlist>
83
 
  </refsection>
84
 
  <refsection id="Palette_PULSE_SC">
85
 
    <title>Palette</title>
86
 
    <itemizedlist>
87
 
      <listitem>
88
 
        <para>
89
 
          <link linkend="Sources_pal">Sources palette</link>
90
 
        </para>
91
 
      </listitem>
92
 
    </itemizedlist>
93
 
  </refsection>
94
 
  <refsection id="Description_PULSE_SC">
95
 
    <title>Description</title>
96
 
    <para>
97
 
      This block is a Pulse Generator. It generates a pulse at a rate of 
98
 
      <emphasis role="bold">1/P</emphasis> where <emphasis role="bold">P
99
 
      </emphasis>
100
 
      is the period of the signal. The <emphasis role="bold">Phase
101
 
        delay
102
 
      </emphasis>
103
 
      gives the value (in time) of the first event. The 
104
 
      <emphasis role="bold">Phase delay</emphasis> known also as <emphasis role="bold">Offset</emphasis> must be less than the <literal>Frequency*(1-(Pulse_Width/100))</literal>.
105
 
      The second parameter of the block gives the <emphasis role="bold">Pulse
106
 
        width
107
 
      </emphasis>
108
 
      and the fourth parameter gives the <emphasis role="bold">Pulse amplitude</emphasis>.
109
 
    </para>
110
 
  </refsection>
111
 
  <refsection id="Dialogbox_PULSE_SC">
112
 
    <title>Dialog box</title>
113
 
    <para>
114
 
      <inlinemediaobject>
115
 
        <imageobject>
116
 
          <imagedata fileref="../../../gui/sources_pal/en_US/PULSE_SC_gui.png" align="center"/>
117
 
        </imageobject>
118
 
      </inlinemediaobject>
119
 
    </para>
120
 
    <para/>
121
 
    <itemizedlist>
122
 
      <listitem>
123
 
        <para>
124
 
          <emphasis role="bold">Phase delay (secs)</emphasis>
125
 
        </para>
126
 
        <para>
127
 
          The offset of the block. It must be less than <literal>Frequency*(1-(Pulse_width/100))</literal>.
128
 
        </para>
129
 
        <para>Type 'pol' of size -1.</para>
130
 
      </listitem>
131
 
      <listitem>
132
 
        <para>
133
 
          <emphasis role="bold">Pulse Width (% of period)</emphasis>
134
 
        </para>
135
 
        <para>
136
 
          The pulse width. It can take values from 1 to 100. 
137
 
        </para>
138
 
        <para>Type 'pol' of size -1.</para>
139
 
      </listitem>
140
 
      <listitem>
141
 
        <para>
142
 
          <emphasis role="bold">Period (secs)</emphasis>
143
 
        </para>
144
 
        <para>
145
 
          The Period of the signal.
146
 
        </para>
147
 
        <para>Properties : Type 'pol' of size -1.</para>
148
 
      </listitem>
149
 
      <listitem>
150
 
        <para>
151
 
          <emphasis role="bold">Amplitude</emphasis>
152
 
        </para>
153
 
        <para>
154
 
          The amplitude of the pulse. It can support all scicos types.
155
 
        </para>
156
 
        <para>Properties : Type 'mat' of size [-1,-1].</para>
157
 
      </listitem>
158
 
    </itemizedlist>
159
 
  </refsection>
160
 
  <refsection id="Defaultproperties_PULSE_SC">
161
 
    <title>Default properties</title>
162
 
    <itemizedlist>
163
 
      <listitem>
164
 
        <para>
165
 
          <emphasis role="bold">always active:</emphasis> no
166
 
        </para>
167
 
      </listitem>
168
 
      <listitem>
169
 
        <para>
170
 
          <emphasis role="bold">direct-feedthrough:</emphasis> no
171
 
        </para>
172
 
      </listitem>
173
 
      <listitem>
174
 
        <para>
175
 
          <emphasis role="bold">zero-crossing:</emphasis> no
176
 
        </para>
177
 
      </listitem>
178
 
      <listitem>
179
 
        <para>
180
 
          <emphasis role="bold">mode:</emphasis> no
181
 
        </para>
182
 
      </listitem>
183
 
      <listitem>
184
 
        <para>
185
 
          <emphasis role="bold">regular outputs:</emphasis>
186
 
        </para>
187
 
        <para>
188
 
          <emphasis role="bold">- port 1 : size [-1,-2] / type -1</emphasis>
189
 
        </para>
190
 
      </listitem>
191
 
      <listitem>
192
 
        <para>
193
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
194
 
        </para>
195
 
      </listitem>
196
 
      <listitem>
197
 
        <para>
198
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
199
 
        </para>
200
 
      </listitem>
201
 
      <listitem>
202
 
        <para>
203
 
          <emphasis role="bold">continuous-time state:</emphasis> no
204
 
        </para>
205
 
      </listitem>
206
 
      <listitem>
207
 
        <para>
208
 
          <emphasis role="bold">discrete-time state:</emphasis> no
209
 
        </para>
210
 
      </listitem>
211
 
      <listitem>
212
 
        <para>
213
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
214
 
        </para>
215
 
      </listitem>
216
 
      <listitem>
217
 
        <para>
218
 
          <emphasis role="bold">name of computational function:</emphasis>
219
 
          <emphasis role="italic">csuper</emphasis>
220
 
        </para>
221
 
      </listitem>
222
 
    </itemizedlist>
223
 
  </refsection>
224
 
  <refsection id="Interfacingfunction_PULSE_SC">
225
 
    <title>Interfacing function</title>
226
 
    <itemizedlist>
227
 
      <listitem>
228
 
        <para>
229
 
          <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/PULSE_SC.sci">SCI/modules/scicos_blocks/macros/Sources/PULSE_SC.sci</link>
230
 
        </para>
231
 
      </listitem>
232
 
    </itemizedlist>
233
 
  </refsection>
234
 
  <refsection role="see also" id="Seealso_PULSE_SC">
235
 
    <title>See also</title>
236
 
    <itemizedlist>
237
 
      <listitem>
238
 
        <link linkend="STEP_FUNCTION">STEP_FUNCTION</link>
239
 
      </listitem>
240
 
      <listitem>
241
 
        <link linkend="RAMP">RAMP</link>
242
 
      </listitem>
243
 
      <listitem>
244
 
        <link linkend="CURV_f">CURV_f</link>
245
 
      </listitem>
246
 
      <listitem>
247
 
        <link linkend="Sigbuilder">Sigbuilder</link>
248
 
      </listitem>
249
 
    </itemizedlist>
250
 
  </refsection>
 
26
    <refnamediv>
 
27
        <refname>PULSE_SC</refname>
 
28
        <refpurpose>Pulse Generator</refpurpose>
 
29
    </refnamediv>
 
30
    <refsection>
 
31
        <title>Block Screenshot</title>
 
32
        <para>
 
33
            <inlinemediaobject>
 
34
                <imageobject>
 
35
                    <imagedata fileref="../../../../images/palettes/PULSE_SC.png" align="center" valign="middle"/>
 
36
                </imageobject>
 
37
            </inlinemediaobject>
 
38
        </para>
 
39
    </refsection>
 
40
    <refsection id="Contents_PULSE_SC">
 
41
        <title>Contents</title>
 
42
        <itemizedlist>
 
43
            <listitem>
 
44
                <para>
 
45
                    <link linkend="PULSE_SC">Pulse Generator</link>
 
46
                </para>
 
47
            </listitem>
 
48
            <listitem>
 
49
                <itemizedlist>
 
50
                    <listitem>
 
51
                        <para>
 
52
                            <xref linkend="Palette_PULSE_SC">Palette</xref>
 
53
                        </para>
 
54
                    </listitem>
 
55
                    <listitem>
 
56
                        <para>
 
57
                            <xref linkend="Description_PULSE_SC">Description</xref>
 
58
                        </para>
 
59
                    </listitem>
 
60
                    <listitem>
 
61
                        <para>
 
62
                            <xref linkend="Dialogbox_PULSE_SC">Dialog box</xref>
 
63
                        </para>
 
64
                    </listitem>
 
65
                    <listitem>
 
66
                        <para>
 
67
                            <xref linkend="Defaultproperties_PULSE_SC">Default properties</xref>
 
68
                        </para>
 
69
                    </listitem>
 
70
                    <listitem>
 
71
                        <para>
 
72
                            <xref linkend="Interfacingfunction_PULSE_SC">Interfacing function</xref>
 
73
                        </para>
 
74
                    </listitem>
 
75
                    <listitem>
 
76
                        <para>
 
77
                            <xref linkend="Seealso_PULSE_SC">See also</xref>
 
78
                        </para>
 
79
                    </listitem>
 
80
                </itemizedlist>
 
81
            </listitem>
 
82
        </itemizedlist>
 
83
    </refsection>
 
84
    <refsection id="Palette_PULSE_SC">
 
85
        <title>Palette</title>
 
86
        <itemizedlist>
 
87
            <listitem>
 
88
                <para>
 
89
                    <link linkend="Sources_pal">Sources palette</link>
 
90
                </para>
 
91
            </listitem>
 
92
        </itemizedlist>
 
93
    </refsection>
 
94
    <refsection id="Description_PULSE_SC">
 
95
        <title>Description</title>
 
96
        <para>
 
97
            This block is a Pulse Generator. It generates a pulse at a rate of 
 
98
            <emphasis role="bold">1/P</emphasis> where <emphasis role="bold">P
 
99
            </emphasis>
 
100
            is the period of the signal. The <emphasis role="bold">Phase
 
101
                delay
 
102
            </emphasis>
 
103
            gives the value (in time) of the first event. The 
 
104
            <emphasis role="bold">Phase delay</emphasis> known also as <emphasis role="bold">Offset</emphasis> must be less than the <literal>Frequency*(1-(Pulse_Width/100))</literal>.
 
105
            The second parameter of the block gives the <emphasis role="bold">Pulse
 
106
                width
 
107
            </emphasis>
 
108
            and the fourth parameter gives the <emphasis role="bold">Pulse amplitude</emphasis>.
 
109
        </para>
 
110
    </refsection>
 
111
    <refsection id="Dialogbox_PULSE_SC">
 
112
        <title>Dialog box</title>
 
113
        <para>
 
114
            <inlinemediaobject>
 
115
                <imageobject>
 
116
                    <imagedata fileref="../../../gui/sources_pal/en_US/PULSE_SC_gui.png" align="center"/>
 
117
                </imageobject>
 
118
            </inlinemediaobject>
 
119
        </para>
 
120
        <para/>
 
121
        <itemizedlist>
 
122
            <listitem>
 
123
                <para>
 
124
                    <emphasis role="bold">Phase delay (secs)</emphasis>
 
125
                </para>
 
126
                <para>
 
127
                    The offset of the block. It must be less than <literal>Frequency*(1-(Pulse_width/100))</literal>.
 
128
                </para>
 
129
                <para>Type 'pol' of size -1.</para>
 
130
            </listitem>
 
131
            <listitem>
 
132
                <para>
 
133
                    <emphasis role="bold">Pulse Width (% of period)</emphasis>
 
134
                </para>
 
135
                <para>
 
136
                    The pulse width. It can take values from 1 to 100. 
 
137
                </para>
 
138
                <para>Type 'pol' of size -1.</para>
 
139
            </listitem>
 
140
            <listitem>
 
141
                <para>
 
142
                    <emphasis role="bold">Period (secs)</emphasis>
 
143
                </para>
 
144
                <para>
 
145
                    The Period of the signal.
 
146
                </para>
 
147
                <para>Properties : Type 'pol' of size -1.</para>
 
148
            </listitem>
 
149
            <listitem>
 
150
                <para>
 
151
                    <emphasis role="bold">Amplitude</emphasis>
 
152
                </para>
 
153
                <para>
 
154
                    The amplitude of the pulse. It can support all scicos types.
 
155
                </para>
 
156
                <para>Properties : Type 'mat' of size [-1,-1].</para>
 
157
            </listitem>
 
158
        </itemizedlist>
 
159
    </refsection>
 
160
    <refsection id="Defaultproperties_PULSE_SC">
 
161
        <title>Default properties</title>
 
162
        <itemizedlist>
 
163
            <listitem>
 
164
                <para>
 
165
                    <emphasis role="bold">always active:</emphasis> no
 
166
                </para>
 
167
            </listitem>
 
168
            <listitem>
 
169
                <para>
 
170
                    <emphasis role="bold">direct-feedthrough:</emphasis> no
 
171
                </para>
 
172
            </listitem>
 
173
            <listitem>
 
174
                <para>
 
175
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
176
                </para>
 
177
            </listitem>
 
178
            <listitem>
 
179
                <para>
 
180
                    <emphasis role="bold">mode:</emphasis> no
 
181
                </para>
 
182
            </listitem>
 
183
            <listitem>
 
184
                <para>
 
185
                    <emphasis role="bold">regular outputs:</emphasis>
 
186
                </para>
 
187
                <para>
 
188
                    <emphasis role="bold">- port 1 : size [-1,-2] / type -1</emphasis>
 
189
                </para>
 
190
            </listitem>
 
191
            <listitem>
 
192
                <para>
 
193
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 0
 
194
                </para>
 
195
            </listitem>
 
196
            <listitem>
 
197
                <para>
 
198
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
199
                </para>
 
200
            </listitem>
 
201
            <listitem>
 
202
                <para>
 
203
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
204
                </para>
 
205
            </listitem>
 
206
            <listitem>
 
207
                <para>
 
208
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
209
                </para>
 
210
            </listitem>
 
211
            <listitem>
 
212
                <para>
 
213
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
214
                </para>
 
215
            </listitem>
 
216
            <listitem>
 
217
                <para>
 
218
                    <emphasis role="bold">name of computational function:</emphasis>
 
219
                    <emphasis role="italic">csuper</emphasis>
 
220
                </para>
 
221
            </listitem>
 
222
        </itemizedlist>
 
223
    </refsection>
 
224
    <refsection id="Interfacingfunction_PULSE_SC">
 
225
        <title>Interfacing function</title>
 
226
        <itemizedlist>
 
227
            <listitem>
 
228
                <para>
 
229
                    <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/PULSE_SC.sci">SCI/modules/scicos_blocks/macros/Sources/PULSE_SC.sci</link>
 
230
                </para>
 
231
            </listitem>
 
232
        </itemizedlist>
 
233
    </refsection>
 
234
    <refsection role="see also" id="Seealso_PULSE_SC">
 
235
        <title>See also</title>
 
236
        <itemizedlist>
 
237
            <listitem>
 
238
                <link linkend="STEP_FUNCTION">STEP_FUNCTION</link>
 
239
            </listitem>
 
240
            <listitem>
 
241
                <link linkend="RAMP">RAMP</link>
 
242
            </listitem>
 
243
            <listitem>
 
244
                <link linkend="CURV_f">CURV_f</link>
 
245
            </listitem>
 
246
            <listitem>
 
247
                <link linkend="Sigbuilder">Sigbuilder</link>
 
248
            </listitem>
 
249
        </itemizedlist>
 
250
    </refsection>
251
251
</refentry>