← 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/Sinks_pal/CMAT3D.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/Sinks_pal/CMAT3D.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="CMAT3D">
25
 
  <refnamediv>
26
 
    <refname>CMAT3D</refname>
27
 
    <refpurpose>Matrix z values 3D viewer</refpurpose>
28
 
  </refnamediv>
29
 
  <refsection>
30
 
    <title>Block Screenshot</title>
31
 
    <para>
32
 
      <inlinemediaobject>
33
 
        <imageobject>
34
 
          <imagedata fileref="../../../../images/palettes/CMAT3D.png" align="center" valign="middle"/>
35
 
        </imageobject>
36
 
      </inlinemediaobject>
37
 
    </para>
38
 
  </refsection>
39
 
  <refsection id="Contents_CMAT3D">
40
 
    <title>Contents</title>
41
 
    <itemizedlist>
42
 
      <listitem>
43
 
        <para>
44
 
          <link linkend="CMAT3D">Matrix z values 3D viewer</link>
45
 
        </para>
46
 
      </listitem>
47
 
      <listitem>
48
 
        <itemizedlist>
49
 
          <listitem>
50
 
            <para>
51
 
              <xref linkend="Palette_CMAT3D">Palette</xref>
52
 
            </para>
53
 
          </listitem>
54
 
          <listitem>
55
 
            <para>
56
 
              <xref linkend="Description_CMAT3D">Description</xref>
57
 
            </para>
58
 
          </listitem>
59
 
          <listitem>
60
 
            <para>
61
 
              <xref linkend="Dialogbox_CMAT3D">Dialog box</xref>
62
 
            </para>
63
 
          </listitem>
64
 
          <listitem>
65
 
            <para>
66
 
              <xref linkend="Defaultproperties_CMAT3D">Default properties</xref>
67
 
            </para>
68
 
          </listitem>
69
 
          <listitem>
70
 
            <para>
71
 
              <xref linkend="Interfacingfunction_CMAT3D">Interfacing function</xref>
72
 
            </para>
73
 
          </listitem>
74
 
          <listitem>
75
 
            <para>
76
 
              <xref linkend="Computationalfunction_CMAT3D">Computational function</xref>
77
 
            </para>
78
 
          </listitem>
79
 
          <listitem>
80
 
            <para>
81
 
              <xref linkend="Seealso_CMAT3D">See also</xref>
82
 
            </para>
83
 
          </listitem>
84
 
        </itemizedlist>
85
 
      </listitem>
86
 
    </itemizedlist>
87
 
  </refsection>
88
 
  <refsection id="Palette_CMAT3D">
89
 
    <title>Palette</title>
90
 
    <itemizedlist>
91
 
      <listitem>
92
 
        <para>
93
 
          <link linkend="Sinks_pal">Sinks palette</link>
94
 
        </para>
95
 
      </listitem>
96
 
    </itemizedlist>
97
 
  </refsection>
98
 
  <refsection id="Description_CMAT3D">
99
 
    <title>Description</title>
100
 
    <para>
101
 
      CMAT3D is a scope that shows matrix values as z values on a xy grid.  
102
 
    </para>
103
 
    <para>
104
 
    </para>
105
 
  </refsection>
106
 
  <refsection id="Dialogbox_CMAT3D">
107
 
    <title>Dialog box</title>
108
 
    <para>
109
 
      <inlinemediaobject>
110
 
        <imageobject>
111
 
          <imagedata fileref="../../../../images/gui/CMAT3D_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">Bounds Vector X (-1 for standard)</emphasis>
122
 
        </para>
123
 
        <para> If you let -1 the x ticks would be between 0 and 1 else you can put your own vector.</para>
124
 
        <para> Properties : Type 'vec' of size -1. </para>
125
 
      </listitem>
126
 
      <listitem>
127
 
        <para>
128
 
          <emphasis role="bold">Bounds Vector Y (-1 for standard)</emphasis>
129
 
        </para>
130
 
        <para> If you let -1 the x ticks would be between 0 and 1 else you can put your own vector.</para>
131
 
        <para> Properties : Type 'vec' of size -1. </para>
132
 
      </listitem>
133
 
      <listitem>
134
 
        <para>
135
 
          <emphasis role="bold">ColorMap</emphasis>
136
 
        </para>
137
 
        <para> The colormap is a range color linked to the window output of the scope. You can put a jetcolormap or hotcolormap or graycolormap or your own (see colormap help).</para>
138
 
        <para>
139
 
          Properties : Must be a mx3 matrix and m
140
 
          <inlinemediaobject>
141
 
            <imageobject>
142
 
              <imagedata fileref="../../../../help/images/CMAT3D_img3_eng.gif" align="center" valign="middle"/>
143
 
            </imageobject>
144
 
          </inlinemediaobject>
145
 
          = 3 
146
 
        </para>
147
 
      </listitem>
148
 
      <listitem>
149
 
        <para>
150
 
          <emphasis role="bold">Zmin</emphasis>
151
 
        </para>
152
 
        <para> Minimum value in Z values</para>
153
 
        <para> Properties : Type 'vec' of size 1. </para>
154
 
      </listitem>
155
 
      <listitem>
156
 
        <para>
157
 
          <emphasis role="bold">Zmax</emphasis>
158
 
        </para>
159
 
        <para> Maximum values in Z values</para>
160
 
        <para> Properties : Type 'vec' of size 1.</para>
161
 
      </listitem>
162
 
    </itemizedlist>
163
 
  </refsection>
164
 
  <refsection id="Defaultproperties_CMAT3D">
165
 
    <title>Default properties</title>
166
 
    <itemizedlist>
167
 
      <listitem>
168
 
        <para>
169
 
          <emphasis role="bold">always active:</emphasis> no
170
 
        </para>
171
 
      </listitem>
172
 
      <listitem>
173
 
        <para>
174
 
          <emphasis role="bold">direct-feedthrough:</emphasis> yes
175
 
        </para>
176
 
      </listitem>
177
 
      <listitem>
178
 
        <para>
179
 
          <emphasis role="bold">zero-crossing:</emphasis> no
180
 
        </para>
181
 
      </listitem>
182
 
      <listitem>
183
 
        <para>
184
 
          <emphasis role="bold">mode:</emphasis> no
185
 
        </para>
186
 
      </listitem>
187
 
      <listitem>
188
 
        <para>
189
 
          <emphasis role="bold">regular inputs:</emphasis>
190
 
        </para>
191
 
        <para>
192
 
          <emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
193
 
        </para>
194
 
      </listitem>
195
 
      <listitem>
196
 
        <para>
197
 
          <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
198
 
        </para>
199
 
      </listitem>
200
 
      <listitem>
201
 
        <para>
202
 
          <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
203
 
        </para>
204
 
      </listitem>
205
 
      <listitem>
206
 
        <para>
207
 
          <emphasis role="bold">continuous-time state:</emphasis> no
208
 
        </para>
209
 
      </listitem>
210
 
      <listitem>
211
 
        <para>
212
 
          <emphasis role="bold">discrete-time state:</emphasis> no
213
 
        </para>
214
 
      </listitem>
215
 
      <listitem>
216
 
        <para>
217
 
          <emphasis role="bold">object discrete-time state:</emphasis> no
218
 
        </para>
219
 
      </listitem>
220
 
      <listitem>
221
 
        <para>
222
 
          <emphasis role="bold">name of computational function:</emphasis>
223
 
          <emphasis role="italic">cmat3d</emphasis>
224
 
        </para>
225
 
      </listitem>
226
 
    </itemizedlist>
227
 
  </refsection>
228
 
  <refsection id="Interfacingfunction_CMAT3D">
229
 
    <title>Interfacing function</title>
230
 
    <itemizedlist>
231
 
      <listitem>
232
 
        <para> SCI/modules/scicos_blocks/macros/Sinks/CMAT3D.sci</para>
233
 
      </listitem>
234
 
    </itemizedlist>
235
 
  </refsection>
236
 
  <refsection id="Computationalfunction_CMAT3D">
237
 
    <title>Computational function</title>
238
 
    <itemizedlist>
239
 
      <listitem>
240
 
        <para> SCI/modules/scicos_blocks/src/c/cmat3d.c (Type 4)</para>
241
 
      </listitem>
242
 
    </itemizedlist>
243
 
  </refsection>
244
 
  <refsection id="Seealso_CMAT3D">
245
 
    <title>See also</title>
246
 
    <itemizedlist>
247
 
      <listitem>
248
 
        <para>
249
 
          <link linkend="CMATVIEW">CMATVIEW - Matrix Colormapped viewer</link>
250
 
        </para>
251
 
      </listitem>
252
 
    </itemizedlist>
253
 
  </refsection>
 
25
    <refnamediv>
 
26
        <refname>CMAT3D</refname>
 
27
        <refpurpose>Matrix z values 3D viewer</refpurpose>
 
28
    </refnamediv>
 
29
    <refsection>
 
30
        <title>Block Screenshot</title>
 
31
        <para>
 
32
            <inlinemediaobject>
 
33
                <imageobject>
 
34
                    <imagedata fileref="../../../../images/palettes/CMAT3D.png" align="center" valign="middle"/>
 
35
                </imageobject>
 
36
            </inlinemediaobject>
 
37
        </para>
 
38
    </refsection>
 
39
    <refsection id="Contents_CMAT3D">
 
40
        <title>Contents</title>
 
41
        <itemizedlist>
 
42
            <listitem>
 
43
                <para>
 
44
                    <link linkend="CMAT3D">Matrix z values 3D viewer</link>
 
45
                </para>
 
46
            </listitem>
 
47
            <listitem>
 
48
                <itemizedlist>
 
49
                    <listitem>
 
50
                        <para>
 
51
                            <xref linkend="Palette_CMAT3D">Palette</xref>
 
52
                        </para>
 
53
                    </listitem>
 
54
                    <listitem>
 
55
                        <para>
 
56
                            <xref linkend="Description_CMAT3D">Description</xref>
 
57
                        </para>
 
58
                    </listitem>
 
59
                    <listitem>
 
60
                        <para>
 
61
                            <xref linkend="Dialogbox_CMAT3D">Dialog box</xref>
 
62
                        </para>
 
63
                    </listitem>
 
64
                    <listitem>
 
65
                        <para>
 
66
                            <xref linkend="Defaultproperties_CMAT3D">Default properties</xref>
 
67
                        </para>
 
68
                    </listitem>
 
69
                    <listitem>
 
70
                        <para>
 
71
                            <xref linkend="Interfacingfunction_CMAT3D">Interfacing function</xref>
 
72
                        </para>
 
73
                    </listitem>
 
74
                    <listitem>
 
75
                        <para>
 
76
                            <xref linkend="Computationalfunction_CMAT3D">Computational function</xref>
 
77
                        </para>
 
78
                    </listitem>
 
79
                    <listitem>
 
80
                        <para>
 
81
                            <xref linkend="Seealso_CMAT3D">See also</xref>
 
82
                        </para>
 
83
                    </listitem>
 
84
                </itemizedlist>
 
85
            </listitem>
 
86
        </itemizedlist>
 
87
    </refsection>
 
88
    <refsection id="Palette_CMAT3D">
 
89
        <title>Palette</title>
 
90
        <itemizedlist>
 
91
            <listitem>
 
92
                <para>
 
93
                    <link linkend="Sinks_pal">Sinks palette</link>
 
94
                </para>
 
95
            </listitem>
 
96
        </itemizedlist>
 
97
    </refsection>
 
98
    <refsection id="Description_CMAT3D">
 
99
        <title>Description</title>
 
100
        <para>
 
101
            CMAT3D is a scope that shows matrix values as z values on a xy grid.  
 
102
        </para>
 
103
        <para>
 
104
        </para>
 
105
    </refsection>
 
106
    <refsection id="Dialogbox_CMAT3D">
 
107
        <title>Dialog box</title>
 
108
        <para>
 
109
            <inlinemediaobject>
 
110
                <imageobject>
 
111
                    <imagedata fileref="../../../../images/gui/CMAT3D_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">Bounds Vector X (-1 for standard)</emphasis>
 
122
                </para>
 
123
                <para> If you let -1 the x ticks would be between 0 and 1 else you can put your own vector.</para>
 
124
                <para> Properties : Type 'vec' of size -1. </para>
 
125
            </listitem>
 
126
            <listitem>
 
127
                <para>
 
128
                    <emphasis role="bold">Bounds Vector Y (-1 for standard)</emphasis>
 
129
                </para>
 
130
                <para> If you let -1 the x ticks would be between 0 and 1 else you can put your own vector.</para>
 
131
                <para> Properties : Type 'vec' of size -1. </para>
 
132
            </listitem>
 
133
            <listitem>
 
134
                <para>
 
135
                    <emphasis role="bold">ColorMap</emphasis>
 
136
                </para>
 
137
                <para> The colormap is a range color linked to the window output of the scope. You can put a jetcolormap or hotcolormap or graycolormap or your own (see colormap help).</para>
 
138
                <para>
 
139
                    Properties : Must be a mx3 matrix and m
 
140
                    <inlinemediaobject>
 
141
                        <imageobject>
 
142
                            <imagedata fileref="../../../../help/images/CMAT3D_img3_eng.gif" align="center" valign="middle"/>
 
143
                        </imageobject>
 
144
                    </inlinemediaobject>
 
145
                    = 3 
 
146
                </para>
 
147
            </listitem>
 
148
            <listitem>
 
149
                <para>
 
150
                    <emphasis role="bold">Zmin</emphasis>
 
151
                </para>
 
152
                <para> Minimum value in Z values</para>
 
153
                <para> Properties : Type 'vec' of size 1. </para>
 
154
            </listitem>
 
155
            <listitem>
 
156
                <para>
 
157
                    <emphasis role="bold">Zmax</emphasis>
 
158
                </para>
 
159
                <para> Maximum values in Z values</para>
 
160
                <para> Properties : Type 'vec' of size 1.</para>
 
161
            </listitem>
 
162
        </itemizedlist>
 
163
    </refsection>
 
164
    <refsection id="Defaultproperties_CMAT3D">
 
165
        <title>Default properties</title>
 
166
        <itemizedlist>
 
167
            <listitem>
 
168
                <para>
 
169
                    <emphasis role="bold">always active:</emphasis> no
 
170
                </para>
 
171
            </listitem>
 
172
            <listitem>
 
173
                <para>
 
174
                    <emphasis role="bold">direct-feedthrough:</emphasis> yes
 
175
                </para>
 
176
            </listitem>
 
177
            <listitem>
 
178
                <para>
 
179
                    <emphasis role="bold">zero-crossing:</emphasis> no
 
180
                </para>
 
181
            </listitem>
 
182
            <listitem>
 
183
                <para>
 
184
                    <emphasis role="bold">mode:</emphasis> no
 
185
                </para>
 
186
            </listitem>
 
187
            <listitem>
 
188
                <para>
 
189
                    <emphasis role="bold">regular inputs:</emphasis>
 
190
                </para>
 
191
                <para>
 
192
                    <emphasis role="bold">- port 1 : size [-1,-2] / type 1</emphasis>
 
193
                </para>
 
194
            </listitem>
 
195
            <listitem>
 
196
                <para>
 
197
                    <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
 
198
                </para>
 
199
            </listitem>
 
200
            <listitem>
 
201
                <para>
 
202
                    <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
 
203
                </para>
 
204
            </listitem>
 
205
            <listitem>
 
206
                <para>
 
207
                    <emphasis role="bold">continuous-time state:</emphasis> no
 
208
                </para>
 
209
            </listitem>
 
210
            <listitem>
 
211
                <para>
 
212
                    <emphasis role="bold">discrete-time state:</emphasis> no
 
213
                </para>
 
214
            </listitem>
 
215
            <listitem>
 
216
                <para>
 
217
                    <emphasis role="bold">object discrete-time state:</emphasis> no
 
218
                </para>
 
219
            </listitem>
 
220
            <listitem>
 
221
                <para>
 
222
                    <emphasis role="bold">name of computational function:</emphasis>
 
223
                    <emphasis role="italic">cmat3d</emphasis>
 
224
                </para>
 
225
            </listitem>
 
226
        </itemizedlist>
 
227
    </refsection>
 
228
    <refsection id="Interfacingfunction_CMAT3D">
 
229
        <title>Interfacing function</title>
 
230
        <itemizedlist>
 
231
            <listitem>
 
232
                <para> SCI/modules/scicos_blocks/macros/Sinks/CMAT3D.sci</para>
 
233
            </listitem>
 
234
        </itemizedlist>
 
235
    </refsection>
 
236
    <refsection id="Computationalfunction_CMAT3D">
 
237
        <title>Computational function</title>
 
238
        <itemizedlist>
 
239
            <listitem>
 
240
                <para> SCI/modules/scicos_blocks/src/c/cmat3d.c (Type 4)</para>
 
241
            </listitem>
 
242
        </itemizedlist>
 
243
    </refsection>
 
244
    <refsection id="Seealso_CMAT3D">
 
245
        <title>See also</title>
 
246
        <itemizedlist>
 
247
            <listitem>
 
248
                <para>
 
249
                    <link linkend="CMATVIEW">CMATVIEW - Matrix Colormapped viewer</link>
 
250
                </para>
 
251
            </listitem>
 
252
        </itemizedlist>
 
253
    </refsection>
254
254
</refentry>