← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/graphics/help/en_US/2d_plot/fec_properties.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/graphics/help/en_US/2d_plot/fec_properties.xml
11
11
 *
12
12
 -->
13
13
<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" xmlns:scilab="http://www.scilab.org" version="5.0-subset Scilab" xml:lang="en" xml:id="fec_properties">
14
 
  <refnamediv>
15
 
    <refname>fec_properties</refname>
16
 
    <refpurpose>description of the fec entities
17
 
      properties
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsection>
21
 
    <title>Description</title>
22
 
    <para>The Fec entity is a leaf of the graphics entities hierarchy. It
23
 
      represents 2D finite elements plots (see <literal>fec</literal>,
24
 
      <literal>Sgrayplot</literal>).
25
 
    </para>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>parent: </term>
29
 
        <listitem>
30
 
          <para>This property contains the handle of the parent. The parent of the
31
 
            fec entity should be of the type <literal>"Axes"</literal> or
32
 
            <literal>"Compound"</literal>.
33
 
          </para>
34
 
        </listitem>
35
 
      </varlistentry>
36
 
      <varlistentry>
37
 
        <term>children: </term>
38
 
        <listitem>
39
 
          <para>
40
 
            This property contains a vector with the <literal>children</literal> of
41
 
            the handle. However, <literal>Fec</literal> handles currently do not have
42
 
            any <literal>children</literal>.
43
 
          </para>
44
 
        </listitem>
45
 
      </varlistentry>
46
 
      <varlistentry>
47
 
        <term>visible: </term>
48
 
        <listitem>
49
 
          <para>
50
 
            This field contains the <literal>visible</literal> property value for
51
 
            the entity . It should be <literal>"on" </literal> or <literal>"off"</literal> .
52
 
            By default, the plot is visible, the value's property is
53
 
            <literal>"on"</literal>. If <literal>"off"</literal> the plot is not drawn on the
54
 
            screen.
55
 
          </para>
56
 
        </listitem>
57
 
      </varlistentry>
58
 
      <varlistentry>
59
 
        <term>data: </term>
60
 
        <listitem>
61
 
          <para>
62
 
            This is a three column matrix <literal>[x,y,f]</literal>, where
63
 
            <literal>x(i)</literal> and <literal>y(i)</literal> are the coordinates of the
64
 
            <literal>i</literal>'th node. <literal>f(i)</literal> is the value associated to
65
 
            the node <literal>i</literal>.
66
 
          </para>
67
 
        </listitem>
68
 
      </varlistentry>
69
 
      <varlistentry>
70
 
        <term>triangles: </term>
71
 
        <listitem>
72
 
          <para>
73
 
            This is a five column matrix <literal>[tn,n1,n2,n3,flag]</literal>.
74
 
            <literal>tn(j)</literal> is the triangle number. <literal>n1(j)</literal>,
75
 
            <literal>n2(j)</literal> and <literal>n3(j)</literal> are the index of the nodes
76
 
            which constitute the triangle. (<literal>flag(j)</literal> is not
77
 
            used).
78
 
          </para>
79
 
        </listitem>
80
 
      </varlistentry>
81
 
      <varlistentry>
82
 
        <term>z_bounds: </term>
83
 
        <listitem>
84
 
          <para>
85
 
            This vector of size 2, <literal>[zmin,zmax]</literal>, gives the z values associated
86
 
            with the first and the last color (of the current colormap). More
87
 
            exactly if the colormap have <literal>nc</literal> colors and if we note <literal>dz
88
 
              = (zmax-zmin)/nc
89
 
            </literal>
90
 
            ,then the part of the triangulation where
91
 
            <literal>zmin + (i-1)dz &lt;= z &lt; zmin + i dz</literal> is filled with the
92
 
            color <literal>i</literal>). By default the <literal>z_bounds</literal> property value
93
 
            is <literal>[0,0]</literal>. In this case, the <literal>zmin</literal> and <literal>zmax</literal> are
94
 
            autommatically set to the minumum and maximum of the <literal>func</literal> argument.
95
 
          </para>
96
 
        </listitem>
97
 
      </varlistentry>
98
 
      <varlistentry>
99
 
        <term>outside_color: </term>
100
 
        <listitem>
101
 
          <para>
102
 
            This vector of size 2, <literal>[cmin, cmax]</literal>, defines the color used
103
 
            when nodes values are outside the <literal>z_bounds = [zmin,zmax]</literal> interval.
104
 
            When node values are lower than <literal>zmin</literal> the color with index <literal>cmin</literal>
105
 
            is used. When node values are greater than <literal>zmax</literal> the color with index <literal>cmax</literal>
106
 
            is used. By default, the <literal>outside_color</literal> property value is <literal>[0,0]</literal>.
107
 
            In this case, <literal>cmin</literal> and <literal>cmax</literal> are automatically set to the two bounds of the colormap.
108
 
            If <literal>cmin</literal> or <literal>cmax</literal> are negative, then values outside z_bounds interval are
109
 
            not displayed, they appear transparent.
110
 
          </para>
111
 
        </listitem>
112
 
      </varlistentry>
113
 
      <varlistentry>
114
 
        <term>color_range: </term>
115
 
        <listitem>
116
 
          <para>
117
 
            This vector of size 2, <literal>[rmin, rmax]</literal>, allows to use only a part of the
118
 
            colormap for display. <literal>rmin</literal> and <literal>rmax</literal> stand for
119
 
            colormap indices. If they are both greater than 1, then the actual colormap used to
120
 
            display the fec entity is <literal>colormap(rmin:rmax)</literal> where <literal>colormap</literal>
121
 
            is the colormap of the parent figure. By default, the <literal>color_range</literal> property value is <literal>[0,0]</literal>.
122
 
            In this case, the whole colormap is used.
123
 
          </para>
124
 
        </listitem>
125
 
      </varlistentry>
126
 
      <varlistentry>
127
 
        <term>line_mode:</term>
128
 
        <listitem>
129
 
          <para>
130
 
            If <literal>"on"</literal>, the wireframe enclosing triangles is drawn.
131
 
            If <literal>"off"</literal>, only the inside of triangles are drawn.
132
 
          </para>
133
 
        </listitem>
134
 
      </varlistentry>
135
 
      <varlistentry>
136
 
        <term>foreground:</term>
137
 
        <listitem>
138
 
          <para>This color index specifies the color of the mesh.
139
 
            If <literal>line_mode</literal> property is <literal>"on"</literal>,
140
 
            the wireframe is drawn using this color.
141
 
          </para>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
      <varlistentry>
145
 
        <term>clip_state: </term>
146
 
        <listitem>
147
 
          <para>
148
 
            This field contains the <literal>clip_state</literal> property value for
149
 
            the fec. It should be :
150
 
          </para>
151
 
          <itemizedlist>
152
 
            <listitem>
153
 
              <para>
154
 
                <literal>"off"</literal> this means that the fec is not
155
 
                clipped.
156
 
              </para>
157
 
            </listitem>
158
 
            <listitem>
159
 
              <para>
160
 
                <literal>"clipgrf"</literal> this means that the fec is clipped
161
 
                outside the Axes box.
162
 
              </para>
163
 
            </listitem>
164
 
            <listitem>
165
 
              <para>
166
 
                <literal>"on"</literal> this means that the fec is clipped
167
 
                outside the rectangle given by property clip_box.
168
 
              </para>
169
 
            </listitem>
170
 
          </itemizedlist>
171
 
        </listitem>
172
 
      </varlistentry>
173
 
      <varlistentry>
174
 
        <term>clip_box: </term>
175
 
        <listitem>
176
 
          <para>
177
 
            This field is to determinate the <literal>clip_box</literal> property.
178
 
            By Default its value should be an empty matrix if clip_state is "off".
179
 
            Other cases the vector <literal>[x,y,w,h]</literal> (upper-left point width
180
 
            height) defines the portions of the fec to display, however
181
 
            <literal>clip_state</literal> property value will be changed.
182
 
          </para>
183
 
        </listitem>
184
 
      </varlistentry>
185
 
      <varlistentry>
186
 
        <term>user_data: </term>
187
 
        <listitem>
188
 
          <para>This field can be use to store any scilab variable in the fec data
189
 
            structure, and to retreive it.
190
 
          </para>
191
 
        </listitem>
192
 
      </varlistentry>
193
 
    </variablelist>
194
 
  </refsection>
195
 
  <refsection>
196
 
    <title>Examples</title>
197
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>fec_properties</refname>
 
16
        <refpurpose>description of the fec entities
 
17
            properties
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsection>
 
21
        <title>Description</title>
 
22
        <para>The Fec entity is a leaf of the graphics entities hierarchy. It
 
23
            represents 2D finite elements plots (see <literal>fec</literal>,
 
24
            <literal>Sgrayplot</literal>).
 
25
        </para>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>parent: </term>
 
29
                <listitem>
 
30
                    <para>This property contains the handle of the parent. The parent of the
 
31
                        fec entity should be of the type <literal>"Axes"</literal> or
 
32
                        <literal>"Compound"</literal>.
 
33
                    </para>
 
34
                </listitem>
 
35
            </varlistentry>
 
36
            <varlistentry>
 
37
                <term>children: </term>
 
38
                <listitem>
 
39
                    <para>
 
40
                        This property contains a vector with the <literal>children</literal> of
 
41
                        the handle. However, <literal>Fec</literal> handles currently do not have
 
42
                        any <literal>children</literal>.
 
43
                    </para>
 
44
                </listitem>
 
45
            </varlistentry>
 
46
            <varlistentry>
 
47
                <term>visible: </term>
 
48
                <listitem>
 
49
                    <para>
 
50
                        This field contains the <literal>visible</literal> property value for
 
51
                        the entity . It should be <literal>"on" </literal> or <literal>"off"</literal> .
 
52
                        By default, the plot is visible, the value's property is
 
53
                        <literal>"on"</literal>. If <literal>"off"</literal> the plot is not drawn on the
 
54
                        screen.
 
55
                    </para>
 
56
                </listitem>
 
57
            </varlistentry>
 
58
            <varlistentry>
 
59
                <term>data: </term>
 
60
                <listitem>
 
61
                    <para>
 
62
                        This is a three column matrix <literal>[x,y,f]</literal>, where
 
63
                        <literal>x(i)</literal> and <literal>y(i)</literal> are the coordinates of the
 
64
                        <literal>i</literal>'th node. <literal>f(i)</literal> is the value associated to
 
65
                        the node <literal>i</literal>.
 
66
                    </para>
 
67
                </listitem>
 
68
            </varlistentry>
 
69
            <varlistentry>
 
70
                <term>triangles: </term>
 
71
                <listitem>
 
72
                    <para>
 
73
                        This is a five column matrix <literal>[tn,n1,n2,n3,flag]</literal>.
 
74
                        <literal>tn(j)</literal> is the triangle number. <literal>n1(j)</literal>,
 
75
                        <literal>n2(j)</literal> and <literal>n3(j)</literal> are the index of the nodes
 
76
                        which constitute the triangle. (<literal>flag(j)</literal> is not
 
77
                        used).
 
78
                    </para>
 
79
                </listitem>
 
80
            </varlistentry>
 
81
            <varlistentry>
 
82
                <term>z_bounds: </term>
 
83
                <listitem>
 
84
                    <para>
 
85
                        This vector of size 2, <literal>[zmin,zmax]</literal>, gives the z values associated
 
86
                        with the first and the last color (of the current colormap). More
 
87
                        exactly if the colormap have <literal>nc</literal> colors and if we note <literal>dz
 
88
                            = (zmax-zmin)/nc
 
89
                        </literal>
 
90
                        ,then the part of the triangulation where
 
91
                        <literal>zmin + (i-1)dz &lt;= z &lt; zmin + i dz</literal> is filled with the
 
92
                        color <literal>i</literal>). By default the <literal>z_bounds</literal> property value
 
93
                        is <literal>[0,0]</literal>. In this case, the <literal>zmin</literal> and <literal>zmax</literal> are
 
94
                        autommatically set to the minumum and maximum of the <literal>func</literal> argument.
 
95
                    </para>
 
96
                </listitem>
 
97
            </varlistentry>
 
98
            <varlistentry>
 
99
                <term>outside_color: </term>
 
100
                <listitem>
 
101
                    <para>
 
102
                        This vector of size 2, <literal>[cmin, cmax]</literal>, defines the color used
 
103
                        when nodes values are outside the <literal>z_bounds = [zmin,zmax]</literal> interval.
 
104
                        When node values are lower than <literal>zmin</literal> the color with index <literal>cmin</literal>
 
105
                        is used. When node values are greater than <literal>zmax</literal> the color with index <literal>cmax</literal>
 
106
                        is used. By default, the <literal>outside_color</literal> property value is <literal>[0,0]</literal>.
 
107
                        In this case, <literal>cmin</literal> and <literal>cmax</literal> are automatically set to the two bounds of the colormap.
 
108
                        If <literal>cmin</literal> or <literal>cmax</literal> are negative, then values outside z_bounds interval are
 
109
                        not displayed, they appear transparent.
 
110
                    </para>
 
111
                </listitem>
 
112
            </varlistentry>
 
113
            <varlistentry>
 
114
                <term>color_range: </term>
 
115
                <listitem>
 
116
                    <para>
 
117
                        This vector of size 2, <literal>[rmin, rmax]</literal>, allows to use only a part of the
 
118
                        colormap for display. <literal>rmin</literal> and <literal>rmax</literal> stand for
 
119
                        colormap indices. If they are both greater than 1, then the actual colormap used to
 
120
                        display the fec entity is <literal>colormap(rmin:rmax)</literal> where <literal>colormap</literal>
 
121
                        is the colormap of the parent figure. By default, the <literal>color_range</literal> property value is <literal>[0,0]</literal>.
 
122
                        In this case, the whole colormap is used.
 
123
                    </para>
 
124
                </listitem>
 
125
            </varlistentry>
 
126
            <varlistentry>
 
127
                <term>line_mode:</term>
 
128
                <listitem>
 
129
                    <para>
 
130
                        If <literal>"on"</literal>, the wireframe enclosing triangles is drawn.
 
131
                        If <literal>"off"</literal>, only the inside of triangles are drawn.
 
132
                    </para>
 
133
                </listitem>
 
134
            </varlistentry>
 
135
            <varlistentry>
 
136
                <term>foreground:</term>
 
137
                <listitem>
 
138
                    <para>This color index specifies the color of the mesh.
 
139
                        If <literal>line_mode</literal> property is <literal>"on"</literal>,
 
140
                        the wireframe is drawn using this color.
 
141
                    </para>
 
142
                </listitem>
 
143
            </varlistentry>
 
144
            <varlistentry>
 
145
                <term>clip_state: </term>
 
146
                <listitem>
 
147
                    <para>
 
148
                        This field contains the <literal>clip_state</literal> property value for
 
149
                        the fec. It should be :
 
150
                    </para>
 
151
                    <itemizedlist>
 
152
                        <listitem>
 
153
                            <para>
 
154
                                <literal>"off"</literal> this means that the fec is not
 
155
                                clipped.
 
156
                            </para>
 
157
                        </listitem>
 
158
                        <listitem>
 
159
                            <para>
 
160
                                <literal>"clipgrf"</literal> this means that the fec is clipped
 
161
                                outside the Axes box.
 
162
                            </para>
 
163
                        </listitem>
 
164
                        <listitem>
 
165
                            <para>
 
166
                                <literal>"on"</literal> this means that the fec is clipped
 
167
                                outside the rectangle given by property clip_box.
 
168
                            </para>
 
169
                        </listitem>
 
170
                    </itemizedlist>
 
171
                </listitem>
 
172
            </varlistentry>
 
173
            <varlistentry>
 
174
                <term>clip_box: </term>
 
175
                <listitem>
 
176
                    <para>
 
177
                        This field is to determinate the <literal>clip_box</literal> property.
 
178
                        By Default its value should be an empty matrix if clip_state is "off".
 
179
                        Other cases the vector <literal>[x,y,w,h]</literal> (upper-left point width
 
180
                        height) defines the portions of the fec to display, however
 
181
                        <literal>clip_state</literal> property value will be changed.
 
182
                    </para>
 
183
                </listitem>
 
184
            </varlistentry>
 
185
            <varlistentry>
 
186
                <term>user_data: </term>
 
187
                <listitem>
 
188
                    <para>This field can be use to store any scilab variable in the fec data
 
189
                        structure, and to retreive it.
 
190
                    </para>
 
191
                </listitem>
 
192
            </varlistentry>
 
193
        </variablelist>
 
194
    </refsection>
 
195
    <refsection>
 
196
        <title>Examples</title>
 
197
        <programlisting role="example"><![CDATA[ 
198
198
x=-10:10; y=-10:10;m =rand(21,21);
199
199
Sgrayplot(x,y,m);
200
200
a=get("current_axes");
202
202
f.data(:,3)=(1:size(f.data,1))';
203
203
a.parent.color_map=hotcolormap(64);
204
204
 ]]></programlisting>
205
 
  </refsection>
206
 
  <refsection role="see also">
207
 
    <title>See Also</title>
208
 
    <simplelist type="inline">
209
 
      <member>
210
 
        <link linkend="set">set</link>
211
 
      </member>
212
 
      <member>
213
 
        <link linkend="get">get</link>
214
 
      </member>
215
 
      <member>
216
 
        <link linkend="delete">delete</link>
217
 
      </member>
218
 
      <member>
219
 
        <link linkend="fec">fec</link>
220
 
      </member>
221
 
      <member>
222
 
        <link linkend="Sgrayplot">Sgrayplot</link>
223
 
      </member>
224
 
      <member>
225
 
        <link linkend="graphics_entities">graphics_entities</link>
226
 
      </member>
227
 
    </simplelist>
228
 
  </refsection>
 
205
    </refsection>
 
206
    <refsection role="see also">
 
207
        <title>See Also</title>
 
208
        <simplelist type="inline">
 
209
            <member>
 
210
                <link linkend="set">set</link>
 
211
            </member>
 
212
            <member>
 
213
                <link linkend="get">get</link>
 
214
            </member>
 
215
            <member>
 
216
                <link linkend="delete">delete</link>
 
217
            </member>
 
218
            <member>
 
219
                <link linkend="fec">fec</link>
 
220
            </member>
 
221
            <member>
 
222
                <link linkend="Sgrayplot">Sgrayplot</link>
 
223
            </member>
 
224
            <member>
 
225
                <link linkend="graphics_entities">graphics_entities</link>
 
226
            </member>
 
227
        </simplelist>
 
228
    </refsection>
229
229
</refentry>