* Bug #8784 fixed - Autoscale for cscope graph
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sinks_pal / CSCOPE.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  *
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * See the file ./license.txt
23  -->
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" xmlns:scilab="http://www.scilab.org" xml:id="CSCOPE">
25     <refnamediv>
26         <refname>CSCOPE</refname>
27         <refpurpose>Single Display Scope</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata fileref="../../../../images/palettes/CSCOPE.png" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37         </para>
38     </refsection>
39     <refsection id="Contents_CSCOPE">
40         <title>Contents</title>
41         <itemizedlist>
42             <listitem>
43                 <para>
44                     <link linkend="CSCOPE">Single Display Scope</link>
45                 </para>
46             </listitem>
47             <listitem>
48                 <itemizedlist>
49                     <listitem>
50                         <para>
51                             <xref linkend="Palette_CSCOPE">Palette</xref>
52                         </para>
53                     </listitem>
54                     <listitem>
55                         <para>
56                             <xref linkend="Description_CSCOPE">Description</xref>
57                         </para>
58                     </listitem>
59                     <listitem>
60                         <para>
61                             <xref linkend="Dialogbox_CSCOPE">Dialog box</xref>
62                         </para>
63                     </listitem>
64                     <listitem>
65                         <para>
66                             <xref linkend="Defaultproperties_CSCOPE">Default properties</xref>
67                         </para>
68                     </listitem>
69                     <listitem>
70                         <para>
71                             <xref linkend="Interfacingfunction_CSCOPE">Interfacing function</xref>
72                         </para>
73                     </listitem>
74                     <listitem>
75                         <para>
76                             <xref linkend="Computationalfunction_CSCOPE">Computational function</xref>
77                         </para>
78                     </listitem>
79                     <listitem>
80                         <para>
81                             <xref linkend="Seealso_CSCOPE">See also</xref>
82                         </para>
83                     </listitem>
84                 </itemizedlist>
85             </listitem>
86         </itemizedlist>
87     </refsection>
88     <refsection id="Palette_CSCOPE">
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_CSCOPE">
99         <title>Description</title>
100         <para>
101             The Scope block displays its input with respect to simulation
102             time. Both axes have a common range.  The Scope allows you to adjust
103             the amount of time and the range of input values displayed.
104
105         </para>
106     </refsection>
107     <refsection id="Dialogbox_CSCOPE">
108         <title>Dialog box</title>
109         <para>
110             <inlinemediaobject>
111                 <imageobject>
112                     <imagedata fileref="../../../../images/gui/CSCOPE_gui.gif" align="center" valign="middle"/>
113                 </imageobject>
114             </inlinemediaobject>
115         </para>
116         <para>
117
118         </para>
119         <itemizedlist>
120             <listitem>
121                 <para>
122                     <emphasis role="bold">Color </emphasis>
123                 </para>
124                 <para>
125                     a vector of integers. The i-th element is the color number (≥ 0) or marker type (&lt; 0) used to draw the evolution of the i-th input port signal. See<emphasis role="bold">plot2d</emphasis> for color (dash type) definitions.
126                 </para>
127                 <para> Properties : Type 'vec' of size 8 </para>
128             </listitem>
129             <listitem>
130                 <para>
131                     <emphasis role="bold">Output window number </emphasis>
132                 </para>
133                 <para>
134                     The number of graphic window used for the display. It is often good to use high values to avoid conflict with palettes and Super Block windows. If default value is used<emphasis role="bold">(1)</emphasis> , Scicos define the output window number.
135                 </para>
136                 <para> Properties : Type 'vec' of size 1 </para>
137             </listitem>
138             <listitem>
139                 <para>
140                     <emphasis role="bold">Output window position</emphasis>
141                 </para>
142                 <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
143                 <para> Properties : Type 'vec' of size 1 </para>
144             </listitem>
145             <listitem>
146                 <para>
147                     <emphasis role="bold">Output window sizes</emphasis>
148                 </para>
149                 <para> a 2 vector specifying the coordinates of the upper left corner of the graphic window. Answer [] for default window position.</para>
150                 <para> Properties : Type 'vec' of size -1 </para>
151             </listitem>
152             <listitem>
153                 <para>
154                     <emphasis role="bold">Ymin</emphasis>
155                 </para>
156                 <para> Minimum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
157                 <para> Properties : Type 'vec' of size 1 </para>
158             </listitem>
159             <listitem>
160                 <para>
161                     <emphasis role="bold">Ymax</emphasis>
162                 </para>
163                 <para> Maximum values of the input; used to set up the Y-axis of the plot in the graphics window.</para>
164                 <para> Properties : Type 'vec' of size 1 </para>
165             </listitem>
166             <listitem>
167                 <para>
168                     <emphasis role="bold">Refresh period</emphasis>
169                 </para>
170                 <para> Maximum value on the X-axis (time). The plot is redrawn when time reaches a multiple of this value.</para>
171                 <para> Properties : Type 'vec' of size 1 </para>
172             </listitem>
173             <listitem>
174                 <para>
175                     <emphasis role="bold">Buffer size</emphasis>
176                 </para>
177                 <para>
178                     To improve efficiency it is possible to buffer the input data. The drawing is only done after each<emphasis role="bold">Buffer size</emphasis> call to the block.
179                 </para>
180                 <para> Properties : Type 'vec' of size 1 </para>
181             </listitem>
182             <listitem>
183                 <para>
184                     <emphasis role="bold">Accept herited events 0/1</emphasis>
185                 </para>
186                 <para>
187                     if 0<emphasis role="bold">CSCOPE_f</emphasis> draws a new point only when an event occurs on its event input port. If 1<emphasis role="bold">CSCOPE_f</emphasis> draws a new point when an event occurs on its event input port and when it's regular input changes due to an event on an other upstream block (herited events).
188                 </para>
189                 <para> Properties : Type 'vec' of size 1 </para>
190             </listitem>
191             <listitem>
192                 <para>
193                     <emphasis role="bold">Name of Scope </emphasis>
194                 </para>
195                 <para> Name/label of the block.</para>
196                 <para> Properties : Type 'str' of size 1</para>
197             </listitem>
198         </itemizedlist>
199     </refsection>
200     <refsection id="Defaultproperties_CSCOPE">
201         <title>Default properties</title>
202         <itemizedlist>
203             <listitem>
204                 <para>
205                     <emphasis role="bold">always active:</emphasis> no
206                 </para>
207             </listitem>
208             <listitem>
209                 <para>
210                     <emphasis role="bold">direct-feedthrough:</emphasis> yes
211                 </para>
212             </listitem>
213             <listitem>
214                 <para>
215                     <emphasis role="bold">zero-crossing:</emphasis> no
216                 </para>
217             </listitem>
218             <listitem>
219                 <para>
220                     <emphasis role="bold">mode:</emphasis> no
221                 </para>
222             </listitem>
223             <listitem>
224                 <para>
225                     <emphasis role="bold">regular inputs:</emphasis>
226                 </para>
227                 <para>
228                     <emphasis role="bold">- port 1 : size [-1,1] / type 1</emphasis>
229                 </para>
230             </listitem>
231             <listitem>
232                 <para>
233                     <emphasis role="bold">number/sizes of activation inputs:</emphasis> 1
234                 </para>
235             </listitem>
236             <listitem>
237                 <para>
238                     <emphasis role="bold">number/sizes of activation outputs:</emphasis> 0
239                 </para>
240             </listitem>
241             <listitem>
242                 <para>
243                     <emphasis role="bold">continuous-time state:</emphasis> no
244                 </para>
245             </listitem>
246             <listitem>
247                 <para>
248                     <emphasis role="bold">discrete-time state:</emphasis> no
249                 </para>
250             </listitem>
251             <listitem>
252                 <para>
253                     <emphasis role="bold">object discrete-time state:</emphasis> no
254                 </para>
255             </listitem>
256             <listitem>
257                 <para>
258                     <emphasis role="bold">name of computational function:</emphasis>
259                     <emphasis role="italic">cscope</emphasis>
260                 </para>
261             </listitem>
262         </itemizedlist>
263     </refsection>
264     <refsection id="Interfacingfunction_CSCOPE">
265         <title>Interfacing function</title>
266         <itemizedlist>
267             <listitem>
268                 <para> SCI/modules/scicos_blocks/macros/Sinks/CSCOPE.sci</para>
269             </listitem>
270         </itemizedlist>
271     </refsection>
272     <refsection id="Computationalfunction_CSCOPE">
273         <title>Computational function</title>
274         <itemizedlist>
275             <listitem>
276                 <para> SCI/modules/scicos_blocks/src/c/cscope.c (Type 4)</para>
277             </listitem>
278         </itemizedlist>
279     </refsection>
280     <refsection id="Example_CSCOPE">
281         <title>Single display scope example</title>
282         <para>
283             <link type="scilab" linkend="scilab.xcos/xcos/examples/sinks_pal/en_US/CSCOPE_en_US.zcos">
284                 <inlinemediaobject>
285                     <imageobject>
286                         <imagedata fileref="../../../../examples/sinks_pal/en_US/CSCOPE_en_US.zcos" align="center" valign="middle"/>
287                     </imageobject>
288                 </inlinemediaobject>
289             </link>
290         </para>
291         <scilab:image><![CDATA[
292             importXcosDiagram(SCI + "/modules/xcos/examples/sinks_pal/en_US/CSCOPE_en_US.zcos");
293             xcos_simulate(scs_m, 4);
294         ]]></scilab:image>
295     </refsection>
296     <refsection id="Seealso_CSCOPE">
297         <title>See also</title>
298         <itemizedlist>
299             <listitem>
300                 <para>
301                     <link linkend="SCALE_CSCOPE">SCALE_CSCOPE - Single Display Scope with autoscale feature of graph</link>
302                 </para>
303             </listitem>
304             <listitem>
305                 <para>
306                     <link linkend="CMSCOPE">CMSCOPE - Multi display scope</link>
307                 </para>
308             </listitem>
309         </itemizedlist>
310     </refsection>
311 </refentry>