"Fossies" - the Fresh Open Source Software Archive

Member "scidavis-2.3.0/doc/dialogs.tex" (12 Jun 2020, 63316 Bytes) of package /linux/misc/scidavis-2.3.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) TeX and LaTeX source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!--
    2 
    3         DESCRIPTION OF THE DIFFERENTS DIALOG BOX
    4         ========================================
    5 
    6         JANUARY 2006: BASED ON VERSION 0.7.7
    7 
    8 -->
    9 <title>The Dialogs</title>
   10 
   11 <!-- ************************************************** -->
   12 <!--        Errorbars               -->
   13 <!-- ************************************************** -->
   14 <sect1 id="add-error-bars-dialog">
   15   <title>Add Error bars</title>
   16   <indexterm><primary>Plot</primary><secondary>Error bars</secondary></indexterm>
   17   <para>This dialog is activated by selecting the &add-error-bars-lnk; from the &graph-menu-lnk;.</para>
   18   <para>This command is used to plot X and/or Y error bars around the data points.</para>
   19   <para>It must be taken care that the "add" button add the errors bars, and so do the "OK" button. Then, you should close the dialog with cancel if you have clicked on the "add" button.</para>
   20   <figure id="fig-add-error-bars-1">
   21     <title>The &add-error-bars-cmd; dialog.</title>
   22     <mediaobject> 
   23       <imageobject>
   24         <imagedata  format="PNG" fileref="pics/add-error-bars-1.png"/>
   25       </imageobject>
   26     </mediaobject>
   27   </figure>
   28   <para>There are three ways to specify the size of the bar:</para>
   29   <variablelist>
   30     <varlistentry> 
   31       <term>A column of the table</term>
   32       <listitem>
   33         <para>In this case, the values of the selected column are used to compute the error bars. if V is the value of the data point, and E the value of the errorbar column, the size of the bars will be V-E to V+E.</para>
   34       </listitem>
   35     </varlistentry>
   36     <varlistentry>
   37       <term>A percentage of the values</term>
   38       <listitem>
   39         <para>if E is the percentage selected, the size of the bars will be V(1-E/100) to V(1+E/100). It must be noticed that, in addition to the errorbars on the plot, this command will create a new column in the active table with can be used in the way as with the previous option. This column can be modified like any other one.</para>
   40       </listitem>
   41     </varlistentry>
   42     <varlistentry>
   43       <term>The standard deviation of the values</term>
   44       <listitem>
   45         <para>the standard deviation of the values. This has a meaning only of the data are centered around an average value. Like with the previous option, a new column will be created in the active table.</para>
   46       </listitem>
   47     </varlistentry>
   48   </variablelist>
   49   <figure id="fig-add-error-bars-2">
   50     <title>A plot with X and Y Error Bars.</title>
   51     <mediaobject> 
   52       <imageobject>
   53         <imagedata  format="PNG" fileref="pics/add-error-bars-2.png"/>
   54       </imageobject>
   55     </mediaobject>
   56   </figure>
   57 </sect1>
   58 
   59 <!-- ************************************************** -->
   60 <!--        Add Function                -->
   61 <!-- ************************************************** -->
   62 <sect1 id="add-function-dialog">
   63   <title>Add Function</title>
   64   <indexterm><primary>Plot</primary><secondary>Plot a function</secondary></indexterm>
   65   <para>This dialog box is used to add a function curve to the active plot. The function can be built with the common operators: * + / - and ^ for the power. The intrinsic functions available are listed in the <link linkend="sec-muParser">appendix</link>.</para>
   66   <para>The most common way to define a function is the classical cartesian coordinate definition y=f(x), this is the defaut option. The two following parameters allow to select the x range used for the plot, and the last one is used for the number of data points that are computed in the X-range.</para>
   67   <figure id="add-function-dialog-1">
   68     <title>The &add-function-cmd; dialog box: cartesian coordinates.</title>
   69     <mediaobject> 
   70       <imageobject>
   71         <imagedata  format="PNG" fileref="pics/add-function-dialog1.png"/>
   72       </imageobject>
   73     </mediaobject>
   74   </figure>
   75   <para>The functions can also be defined in a parametric definition: if <emphasis>t</emphasis> is the parameter, the (x,y) data points are computed by x=f(t) and y=g(t).</para>
   76   <para>The first parameter is the name of the parametric variable (here <emphasis>t</emphasis>) followed by the range, the definition of the two functions and the number of data points.</para>
   77   <figure id="add-function-dialog-2">
   78     <title>The &add-function-cmd; dialog box: parametric coordinates.</title>
   79     <mediaobject> 
   80       <imageobject>
   81         <imagedata  format="PNG" fileref="pics/add-function-dialog2.png"/>
   82       </imageobject>
   83     </mediaobject>
   84   </figure>
   85   <para>The last way is the polar definition of the function: if <emphasis>t</emphasis> is the parameter, the radius <emphasis>r</emphasis> and the angle <emphasis>theta</emphasis> are computed by r=f(t) and theta=g(t). Then the (x,y) data points are computed by x=r*cos(theta) and y=r*sin(theta).</para> 
   86   <para>The first parameter is the name of the parametric variable (here <emphasis>t</emphasis>) followed by the range, the definition of the two functions and the number of data points.The angle is defined in radians, and the constant value <emphasis>pi</emphasis> can be used: it is possible to use 3*pi to define the parameter range.</para>
   87   <figure id="add-function-dialog-3">
   88     <title>The &add-function-cmd; dialog box: polar coordinates.</title>
   89     <mediaobject> 
   90       <imageobject>
   91         <imagedata  format="PNG" fileref="pics/add-function-dialog3.png"/>
   92       </imageobject>
   93     </mediaobject>
   94   </figure>
   95 </sect1>
   96 
   97 <!-- ************************************************** -->
   98 <!--        Add Layer               -->
   99 <!-- ************************************************** -->
  100 <sect1 id="add-layer-dialog">
  101   <title>Add Layer</title>
  102   <indexterm><primary>Multilayers plot</primary><secondary>Add a new layer</secondary></indexterm>
  103   <para>This dialog is opened when you want to add a new layer on the active plot. If you select <emphasis>Guess</emphasis>, &appname; will divide the window in two columns and put the new layer on the right. If you choose <emphasis>Top-Left Corner</emphasis>, &appname; will create a new layer with the maximum possible size over the existing layer, this layer contains an empty plot. You can then modify the size and position of each layer by selecting it with the layer number buttons  <inlinemediaobject><imageobject><imagedata format="PNG" fileref="pics/layer-button.png"/></imageobject></inlinemediaobject> and selecting the <emphasis>Layer Geometry</emphasis> command from the context menu.</para>
  104   <figure id="fig-add-layer-dialog">
  105     <title>The &add-layer-cmd; dialog box.</title>
  106     <mediaobject> 
  107       <imageobject>
  108         <imagedata  format="PNG" fileref="pics/add-layer.png"/>
  109       </imageobject>
  110     </mediaobject>
  111   </figure>
  112 </sect1>
  113 
  114 <!-- ************************************************** -->
  115 <!--        Add / remove curves         -->
  116 <!-- ************************************************** -->
  117 <sect1 id="add-remove-curve-dialog">
  118   <title>Add/Remove curves.</title>
  119   <indexterm><primary>Plot</primary><secondary>Add a curve</secondary></indexterm>
  120   <indexterm><primary>Plot</primary><secondary>Remove a curve</secondary></indexterm>
  121   <para>This dialog is activated by selecting the command <link linkend="add-remove-curve-cmd">&add-remove-curve-cmd;</link> from the <link linkend="sec-graph-menu">Graph Menu</link>.</para>
  122   <para>The left window shows the columns which are available for plotting in the different tables of the project, and the right window gives the list of the curves already plotted. In the case presented below, there are two tables in which the &add-remove-curve-cmd; dialog box allows to select columns. If you use this dialog box to add a column, the X column will be the one define as X in the corresponding table.</para>
  123   <figure id="fig-add-remove-curve">
  124     <title>The &add-remove-curve-cmd; dialog box.</title>
  125     <mediaobject> 
  126       <imageobject>
  127         <imagedata  format="PNG" fileref="pics/add-remove-curve.png"/>
  128       </imageobject>
  129     </mediaobject>
  130   </figure>
  131 
  132   <para>In this dialog box, if you select one curve of the plot in the right window, you can change the columns used for X and Y with the <emphasis>Plot Association</emphasis> button. In any case, you can't mix the X values of one table with the Y values of another one. If you wan't to do this, you have to copy the columns in the same table.</para>
  133   <para>If the curve selected is a function, you can modify it. Refer to the <link linkend="add-function-dialog">&add-function-cmd; dialog box</link> for more details on functions editing.</para>
  134 </sect1>
  135 
  136 <!-- ************************************************** -->
  137 <!--        Add Text                -->
  138 <!-- ************************************************** -->
  139 <sect1 id="add-text-dialog">
  140   <title>Add Text</title>
  141   <indexterm><primary>Text label</primary><secondary>Add a text label</secondary></indexterm>
  142   <para>This dialog box is opened when you use the &add-text-lnk; command  from the &graph-menu-lnk;. If you choose the <emphasis>On new layer</emphasis> option, the text will be inserted as a new layer which has the size and the position of the text. You can then modify the size and position of this layer with the <emphasis>layer Geometry</emphasis> (see the <link linkend="add-layer-dialog">&add-layer-cmd;</link> for details). Beware that in this case, all text which is not in the layer will be clipped, therefore, you need to modify the layer to modify the position of the text. If you choose the <emphasis>On Active layer</emphasis> option, the text will be inserted in the selected layer, and its position can be modified directly with the mouse inside this layer.</para>
  143   <figure id="fig-add-text-dialog">
  144     <title>The &add-text-cmd; dialog box.</title>
  145     <mediaobject> 
  146       <imageobject>
  147         <imagedata  format="PNG" fileref="pics/add-text-dialog.png"/>
  148       </imageobject>
  149     </mediaobject>
  150   </figure>
  151 </sect1>
  152 
  153 <!-- ************************************************** -->
  154 <!--        Arrange Layers              -->
  155 <!-- ************************************************** -->
  156 <sect1 id="arrange-layers-dialog">
  157   <title>Arrange Layers</title>
  158   <indexterm><primary>Multilayers plot</primary><secondary>Organize the layers</secondary></indexterm>
  159   <para>This dialog is activated by selecting the command &arrange-layers-cmd; from the <link linkend="sec-graph-menu">Graph Menu</link> or by the key code &arrange-layers-key;.</para>
  160   <para>It allows to modify the geometrical arrangement of the plots which are already present in the active window. You can also add new layers or remove existing ones.</para>
  161   <figure id="fig-define-layer-1">
  162     <title>The &arrange-layers-cmd; dialog</title>
  163     <mediaobject> 
  164       <imageobject>
  165         <imagedata  format="PNG" fileref="pics/arrange-layers-dialog1.png"/>
  166       </imageobject>
  167     </mediaobject>
  168   </figure>
  169   <para>The <emphasis>Arrange Layers</emphasis> dialog is used to modify the geometrical arrangement of the plots. You can specify the numbers of rows and columns which will define a table of plots. As pointed out above, you can also add or remove layers with this dialog, using the "Number of Layers" box.</para>
  170   <para>With the default setting, &appname; computes the size of the layers from the size of the window. If you check the <emphasis>Layer Canvas Size</emphasis>, you can set the size of the layers and &appname; will modify the size of the window.</para>
  171   <para>The two right zones allow to set the alignment of the layers in the window, and the margins between the layer borders and the window limits.</para>
  172   <para>If you do some modifications on your plot, the alignment of the different axis may not be conserved. You can exec again the &arrange-layers-cmd; to re-arrange your plot.</para>
  173 </sect1>
  174 
  175 <!-- ************************************************** -->
  176 <!--        Arrow Dialog                -->
  177 <!-- ************************************************** -->
  178 <sect1 id="arrow-dialog">
  179   <title>Add Arrow</title>
  180   <indexterm><primary>Arrows and Lines</primary><secondary>Add an arrow/line</secondary></indexterm>
  181   <para>This dialog allows to modify a line or an arrow which has been created by the command <emphasis>&draw-arrow-cmd;</emphasis> from the <link linkend="sec-graph-menu">Graph Menu</link> or with &draw-arrow-key;. One can also open it with a double click on an arrow or a line, or by selecting an arrow or a line and selecting <emphasis>Properties...</emphasis> with the right button of the mouse.</para>
  182   <para>The first tab allows to change the color, the line type and the line width. This last parameter is set in pixels. It is possible to define a default style for all the new lines by pressing the <emphasis>Set Default</emphasis> button.</para>
  183   <figure id="fig-line-options-1">
  184     <title>The <emphasis>Arrow options</emphasis> dialog: first tab</title>
  185     <mediaobject> 
  186       <imageobject>
  187         <imagedata  format="PNG" fileref="pics/line-options-1.png"/>
  188       </imageobject>
  189     </mediaobject>
  190   </figure>
  191   <para>The <emphasis>Arrow head</emphasis> tab is used to modify the shape of the head of the arrow. The length is set in pixels and the angle is in degrees. It is also possible to define a default style for the arrow heads using the same <emphasis>Set Default</emphasis> button.</para>
  192   <figure id="fig-line-options-2">
  193     <title>The <emphasis>Arrow options</emphasis> dialog: second tab</title>
  194     <mediaobject> 
  195       <imageobject>
  196         <imagedata  format="PNG" fileref="pics/line-options-2.png"/>
  197       </imageobject>
  198     </mediaobject>
  199   </figure>
  200   <para>The <emphasis>Geometry</emphasis> tab allows to specify the start and end points of the line/arrow. The coordinates can be set as a function of the scales values displayed on the left axis (Y) and on the bottom axis (X) or in pixels, by choosing the desired method from the <emphasis>Unit</emphasis> pull-down list. The pixel coordinates are relative to the top-left corner of the layer which contains the line.</para>
  201   <figure id="fig-line-options-3">
  202     <title>The <emphasis>Geometry</emphasis> dialog: third tab</title>
  203     <mediaobject> 
  204       <imageobject>
  205         <imagedata  format="PNG" fileref="pics/line-options-3.png"/>
  206       </imageobject>
  207     </mediaobject>
  208   </figure>
  209   <para></para>
  210 
  211 </sect1>
  212 
  213 <!-- ************************************************** -->
  214 <!--        Column Options              -->
  215 <!-- ************************************************** -->
  216 <sect1 id="column-options-dialog">
  217   <title>Column Options</title>
  218   <indexterm><primary>Table</primary><secondary>Columns</secondary><tertiary>Properties</tertiary></indexterm>
  219   <para>This dialog is activated by selecting the command <link linkend="column-options-cmd">&column-options-cmd;</link> from the <link linkend="sec-table-menu">Table Menu</link>. At least one column must be selected.</para>
  220   <figure id="fig-column-options">
  221     <title>The &column-options-cmd; dialog.</title>
  222     <mediaobject> 
  223       <imageobject>
  224         <imagedata  format="PNG" fileref="pics/column-options.png"/>
  225       </imageobject>
  226     </mediaobject>
  227   </figure>
  228   <para>The checkbox <emphasis>Enumerate all to the right</emphasis> can be used to build the name of all the columns which are at the right of the selected one. If the name of the selected column is "xyz", this column and the following ones will be renamed to "xyz1", "xyz2", and so on.</para>
  229   <para>The buttons "&lt;&lt;" and "&gt;&gt;" are used to change the selected column. The highlighting of the column in the table behind the dialog box will change indicating that a new column was selected. The column to which the formatting commands are applied is the one whose name appear in the "Column Name" box.</para>
  230   <para>The <emphasis>Plot Designation</emphasis> selector is used to define the columns which are used as X, Y or Z values or as error bars. In a table you can select several columns as X, in this case in the column label they will be indicated as [X1], [X2], etc... and their corresponding Y columns will be indicated as [Y1], [Y2], etc...</para>
  231 </sect1>
  232 
  233 <!-- ************************************************** -->
  234 <!--        Contour Curves Options          -->
  235 <!-- ************************************************** -->
  236 <sect1 id="contour-options-dialog">
  237   <title>Contour Curves Options</title>
  238   <indexterm><primary>Surface plot</primary><secondary>Contour curves options</secondary></indexterm>
  239   <para>This dialog is activated by clicking on a contour curve (or on the plotting area) when a 3D plot has been created from a matrix with one of the following commands of the &plot3d-menu-lnk;: &contour-color-lnk;, &contour-lines-lnk; or &gray-scale-lnk;.</para>
  240   <figure id="fig-contour-options-1">
  241     <title>The Contour Options dialog.</title>
  242     <mediaobject> 
  243       <imageobject>
  244         <imagedata  format="PNG" fileref="pics/contour-curve-dialog-1.png"/>
  245       </imageobject>
  246     </mediaobject>
  247   </figure>
  248   <para>The first group of settings <emphasis>Image</emphasis> is checked if you want to have a color or gray level filling of the contour plot. The default gray and color maps are the following: </para>
  249   <informalfigure id="fig-contour-options-5">
  250     <mediaobject> 
  251       <imageobject>
  252         <imagedata  format="PNG" fileref="pics/contour-curve-dialog-5.png"/>
  253       </imageobject>
  254     </mediaobject>
  255   </informalfigure>
  256   <informalfigure id="fig-contour-options-6">
  257     <mediaobject> 
  258       <imageobject>
  259         <imagedata  format="PNG" fileref="pics/contour-curve-dialog-6.png"/>
  260       </imageobject>
  261     </mediaobject>
  262   </informalfigure>
  263   <para>You can customize this colormap by checking the <emphasis>Custom Colors</emphasis> box. A table with a set of numbers (the Z levels) and the corresponding colors is presented. You can then add or delete new levels for the definition of the colormap, and modify the corresponding Z levels. You are not allowed to modify the first and last levels, which are set to the minimum and maximum Z values. Beware that this is only the definition of the colormap, it won't change the number of contour lines of your plot. An example of classical custom colormap is given here:</para>
  264     <informalfigure id="fig-contour-options-3">
  265     <mediaobject> 
  266       <imageobject>
  267         <imagedata  format="PNG" fileref="pics/contour-curve-dialog-3.png"/>
  268       </imageobject>
  269     </mediaobject>
  270   </informalfigure>
  271   <para>If you want to obtain discrete colors for each level,you must uncheck the <emphasis>Scale Colors</emphasis> checkbox. In this case you must define enough levels in your colormap.</para>
  272     <informalfigure id="fig-contour-options-4">
  273     <mediaobject> 
  274       <imageobject>
  275         <imagedata  format="PNG" fileref="pics/contour-curve-dialog-4.png"/>
  276       </imageobject>
  277     </mediaobject>
  278   </informalfigure>
  279   <para>The second group of settings is used to customize the contour lines. You can select the number of lines and their color. If you check <emphasis>Use Default Pen</emphasis>, the color of the line will follow the settings defined in the group at the left of the checkbox. If you check <emphasis>Use Color Map</emphasis>, the lines will be colored as a function of the Z levels following the colormap defined in the <emphasis>image</emphasis> setting group.</para>
  280   <para>The last group of settings must be checked if you want to have a bar scale on your plot. You can then define its position and width.</para>
  281 </sect1>
  282 
  283 <!-- ************************************************** -->
  284 <!--        Custom Curves Dialog            -->
  285 <!-- ************************************************** -->
  286 <sect1 id="custom-curves-dialog">
  287   <title>Custom Curves</title>
  288   <indexterm><primary>Plot</primary><secondary>Curves options</secondary></indexterm>
  289   <para>This dialog is activated by selecting the command <link linkend="format-plot-cmd">&format-plot-cmd;</link> from the <link linkend="sec-format-menu">Format Menu</link>. It is also activated by a double click on the plot. If there are more than one layer in the window, &appname; will select the layer which contain the plot under the mouse pointer.</para>
  290   <figure id="fig-custom-curves-1">
  291     <title>The Custom Curves Dialog: Line formatting.</title>
  292     <mediaobject> 
  293       <imageobject>
  294         <imagedata  format="PNG" fileref="pics/custom-curves-1.png"/>
  295       </imageobject>
  296     </mediaobject>
  297   </figure>
  298   <para>The right part of the dialog box contains several tabs which depend on the kind of plot that you are using, they are described in the following subsections. The left part of the dialog window shows the curves which are plotted in the active layer. All the modifications will be done on the selected curve. You can change the columns which are used by clicking on the <emphasis>Plot Associations...</emphasis> button. This will open a dialog which can be used to select the columns of the table which are used as X and Y values.</para>
  299  
  300   <figure id="fig-custom-curves-3">
  301     <title>The Custom Curves Dialog: Plot Associations.</title>
  302     <mediaobject> 
  303       <imageobject>
  304         <imagedata  format="PNG" fileref="pics/custom-curves-3.png"/>
  305       </imageobject>
  306     </mediaobject>
  307   </figure>
  308  <para>The button <emphasis>Worksheet</emphasis> can be used to access to the table which contains the columns selected.</para>
  309 
  310 <sect2 id="custom-curves-dialog-lines">
  311 <title>Custom curves for lines and scatter plots</title>
  312 
  313   <para>This dialog box is activated for plots drawn with <emphasis>symbols</emphasis>, <emphasis>line+symbols</emphasis>, <emphasis>lines</emphasis>, <emphasis>vertical drop lines</emphasis>, <emphasis>steps</emphasis> and <emphasis>splines</emphasis>.</para>
  314   <para>The first tab of the right part of the dialog window allows to modify the style of the line (color, line style, thickness). The connect button allows to change the style which is used to draw the selected curve (steps, droplines, etc). See the &plot-menu-lnk; to see the different types of plot available.</para>
  315   <figure id="fig-custom-curves-line-1">
  316     <title>The Custom Curves Dialog: Line formatting.</title>
  317     <mediaobject> 
  318       <imageobject>
  319         <imagedata  format="PNG" fileref="pics/custom-curves-1.png"/>
  320       </imageobject>
  321     </mediaobject>
  322   </figure>
  323 
  324   <para>A second tab can be activated to select the symbol, and to modify the size, the color and the filling color of the symbols.</para>
  325   <figure id="fig-custom-curves-line-2">
  326     <title>The Custom Curves Dialog: Symbol formatting.</title>
  327     <mediaobject> 
  328       <imageobject>
  329         <imagedata  format="PNG" fileref="pics/custom-curves-2.png"/>
  330       </imageobject>
  331     </mediaobject>
  332   </figure>
  333 
  334 </sect2>
  335 
  336 <sect2 id="custom-curves-dialog-pie">
  337 <title>Custom curves for pie plots</title>
  338   <para>These commands are available for <link linkend="pie-cmd">pie plots</link>. The first tab allows the customization of the pie segments. The left fields are used to modify the border which is drawn round each segment: color, type and width of line. The default is no border (line width = 0).</para>
  339   <para>The right fields are used to define the filling of the plots. The color button defines the one used for the first segment, then the others segments will have colors which follow the order defined in the list. The default value for this field is black, so segment 2, 3, etc will be red, green, etc.</para>
  340   <para>The pattern will be used for all segments of the pie, the default value is solid filling. The last field defines the size of the pie in pixels.</para>
  341   <figure id="fig-custom-curves-pie-1">
  342     <title>The Custom Curves Dialog for pies: pie segment formatting.</title>
  343     <mediaobject> 
  344       <imageobject>
  345         <imagedata  format="PNG" fileref="pics/custom-curves-pie-1.png"/>
  346       </imageobject>
  347     </mediaobject>
  348   </figure>
  349 </sect2>
  350 
  351 <sect2 id="custom-curves-dialog-box">
  352 <title>Custom curves for box plots</title>
  353 <para>x</para>
  354   <figure id="fig-custom-curves-box-1">
  355     <title>The Custom Curves Dialog for box: pattern formatting.</title>
  356     <mediaobject> 
  357       <imageobject>
  358         <imagedata  format="PNG" fileref="pics/custom-curves-box-1.png"/>
  359       </imageobject>
  360     </mediaobject>
  361   </figure>
  362 
  363   <figure id="fig-custom-curves-box-2">
  364     <title>The Custom Curves Dialog for box: whiskers formatting.</title>
  365     <mediaobject> 
  366       <imageobject>
  367         <imagedata  format="PNG" fileref="pics/custom-curves-box-2.png"/>
  368       </imageobject>
  369     </mediaobject>
  370   </figure>
  371 
  372   <figure id="fig-custom-curves-box-3">
  373     <title>The Custom Curves Dialog for box: percentile formatting.</title>
  374     <mediaobject> 
  375       <imageobject>
  376         <imagedata  format="PNG" fileref="pics/custom-curves-box-3.png"/>
  377       </imageobject>
  378     </mediaobject>
  379   </figure>
  380 
  381 </sect2>
  382 
  383 <sect2 id="custom-curves-dialog-histogram">
  384 <title>Custom curves for pie histogram</title>
  385 <para>x</para>
  386   <figure id="fig-custom-curves-histogram-1">
  387     <title>The Custom Curves Dialog for histogram: pattern formatting.</title>
  388     <mediaobject> 
  389       <imageobject>
  390         <imagedata  format="PNG" fileref="pics/custom-curves-histogram-1.png"/>
  391       </imageobject>
  392     </mediaobject>
  393   </figure>
  394   <figure id="fig-custom-curves-histogram-2">
  395     <title>The Custom Curves Dialog for histogram: spacing formatting.</title>
  396     <mediaobject> 
  397       <imageobject>
  398         <imagedata  format="PNG" fileref="pics/custom-curves-histogram-2.png"/>
  399       </imageobject>
  400     </mediaobject>
  401   </figure>
  402   <figure id="fig-custom-curves-histogram-3">
  403     <title>The Custom Curves Dialog for histogram: data formatting.</title>
  404     <mediaobject> 
  405       <imageobject>
  406         <imagedata  format="PNG" fileref="pics/custom-curves-histogram-3.png"/>
  407       </imageobject>
  408     </mediaobject>
  409   </figure>
  410 </sect2>
  411 
  412 </sect1>
  413 
  414 <!-- ************************************************** -->
  415 <!--        Add surface function            -->
  416 <!-- ************************************************** -->
  417 <sect1 id="define-surface-plot-dialog">
  418   <title>Define surface plot</title>
  419   <indexterm><primary>Surface plot</primary><secondary>Create from function</secondary></indexterm>
  420   <para>This dialog is used when you enter the &new-surface-3d-plot-cmd; command. It allows to create a new function of two variables. The only available coordinate system is the Cartesian one: z=f(x,y).</para>
  421   <figure id="fig-define-surface-plot-dialog">
  422     <title>The &new-surface-3d-plot-cmd; dialog box.</title>
  423     <mediaobject> 
  424       <imageobject>
  425         <imagedata  format="PNG" fileref="pics/define-surface-plot.png"/>
  426       </imageobject>
  427     </mediaobject>
  428   </figure>
  429   <para>You can then enter the X, Y and Z scales.</para>
  430 </sect1>
  431 
  432 <!-- ************************************************** -->
  433 <!--        Export ASCII                -->
  434 <!-- ************************************************** -->
  435 <sect1 id="export-ascii-dialog">
  436   <title>Export ASCII</title>
  437   <indexterm><primary>Table</primary><secondary>Export to file</secondary></indexterm>
  438   <para>This dialog is activated by selecting the command <link linkend="export-ascii-cmd">&export-ascii-cmd;</link> from the <link linkend="sec-file-menu">File Menu</link>. It is only active when a table is selected.</para>
  439   <para>This command is used to export all or a part of the data of a project in an ASCII file.</para>
  440   <figure id="fig-export-ascii">
  441     <title>Export of a selection in a table to an ASCII file.</title>
  442     <informalexample>
  443       <para>In this example of export of a selection in a table to an ASCII file, TAB is used as a separator between the columns.</para>
  444     </informalexample>
  445     <mediaobject> 
  446       <imageobject>
  447         <imagedata  format="PNG" fileref="pics/export-ascii.png"/>
  448       </imageobject>
  449     </mediaobject>
  450   </figure>
  451   <para>If the names of the columns have not been set, they will be set to C1,C2,... in the exported file. The formatting of the numbers is kept in the ASCII file, so you have to be careful to obtain a good enough precision in the ASCII file.</para>
  452 </sect1>
  453 
  454 <!-- ************************************************** -->
  455 <!--        FFT                 -->
  456 <!-- ************************************************** -->
  457 <sect1 id="fft-dialog">
  458   <title>Fast Fourier Transform</title>
  459   <indexterm><primary>Curve analysis</primary><secondary>FFT</secondary></indexterm>
  460   <para>The &fft-cmd; dialog box can be used either on a table or on a plot. It is used to compute a direct or inverse FFT. See the <link linkend="sec-fft">FFT section</link> in the <link linkend="analysis">Analysis chapter</link> for an example.</para>
  461   <figure id="fig-fft-dialog-curve">
  462     <title>The &fft-cmd; dialog box for a curve.</title>
  463     <mediaobject> 
  464       <imageobject>
  465         <imagedata  format="PNG" fileref="pics/fft-dialog-curve.png"/>
  466       </imageobject>
  467     </mediaobject>
  468   </figure>
  469   <para>&appname; will create a new plot window with the FFT amplitude curve, and a new table which contains the real part, the imaginary part, the amplitude, and the angle of the FFT.</para>
  470   <para>If the <emphasis>Normalize Amplitude</emphasis> check box is on, the amplitude curve is normalized to 1. If the <emphasis>Shift Results</emphasis> check box is on, the frequencies are shifted in order to obtain a centered x-scale.</para>
  471   <figure id="fig-fft-dialog-table">
  472     <title>The &fft-cmd; dialog box for a table.</title>
  473     <mediaobject> 
  474       <imageobject>
  475         <imagedata  format="PNG" fileref="pics/fft-dialog-table.png"/>
  476       </imageobject>
  477     </mediaobject>
  478   </figure>
  479   <para>In the case of a table, you must select the sampling column (X-values) and two columns for Y-values. If they are complex numbers, the first column is the real part of Y-values and the second is the imaginary part. If Y-values are simple reals, you must select the same column for real and imaginary part.</para>
  480   <para>By default, the <emphasis>Sampling Interval</emphasis> corresponds to the interval between X-values. Giving a smaller value makes no sense, but you can increase this value in order to sample less values</para>
  481 </sect1>
  482 
  483 <!-- ************************************************** -->
  484 <!--        Integrate dialog            -->
  485 <!-- ************************************************** -->
  486 <sect1 id="integrate-dialog">
  487   <title>Integrate dialog</title>
  488   <indexterm><primary>Curve analysis</primary><secondary>Integration</secondary></indexterm>
  489   <para>This dialog box is opened if you select the &integrate-cmd; command from the &analysis-menu-lnk; The first field is the curve that will be integrated. The second one is the order of the integration: the order 1 corresponds to the trapezoid rule, i.e. the curve is approximated by a straight line between 2 successive points. If you choose the order 2, three successive points are used and a second order polynomial is used to approximate the curve. etc. If you have a large amount of points in your curve, the order 1 is enough.</para>
  490   <figure id="fig-integrate-dialog">
  491     <title>The &integrate-cmd; dialog box.</title>
  492     <mediaobject> 
  493       <imageobject>
  494         <imagedata  format="PNG" fileref="pics/integrate-dialog.png"/>
  495       </imageobject>
  496     </mediaobject>
  497   </figure>
  498   <para>The result of the integration will be given in the <link linkend="sec-intro-project-explorer">The Project Explorer</link>.</para>
  499 </sect1>
  500 
  501 <!-- ************************************************** -->
  502 <!--        Non linear curve fit            -->
  503 <!-- ************************************************** -->
  504 <sect1 id="non-linear-curve-fit-dialog">
  505   <title>Non linear curve fit</title>
  506   <indexterm><primary>Curve analysis</primary><secondary>Curve fitting</secondary><tertiary>Non linear function</tertiary></indexterm>
  507   <para>This dialog is activated by selecting the command <link linkend="non-linear-curve-fit-cmd">&non-linear-curve-fit-cmd;</link> from the <link linkend="sec-analysis-menu-plot">Analysis Menu</link>. This command is active if a plot or a table window is selected. In the latter case, this command first creates a new plot window using the list of selected columns in the table.</para>
  508   <para>This dialog is used to fit discrete data points with a mathematical function. The fitting is done by minimizing the least square difference between the data points and the Y values of the function.</para>
  509   <sidebar>
  510     <title>Note:</title>
  511     <para>If the data points are modified, the fit is not re-calculated. Then, you need to remove the old fitted curve and to redo the fit with the same function and the new points.</para>
  512   </sidebar>
  513   <para>The top of the dialog box is used to choose a function among the one which are already define. Four types of functions are availables: the user defined functions which have been saved, the classical functions proposed by &appname; in the analysis menu, the simple elementary built-in functions, and external functions via pluggins.</para>
  514   <para>To choose one of these functions, you just have to select it and to click on the checkbox under the selector.</para>
  515   <para>If you want to define your own function, you can use the bottom half of the dialog box. You can write you own mathematical expression or add expressions obtained with the function selector. Then you need to define the parameters which have to be fitted in a comma separated list.</para>
  516   <figure id="fig-non-linear-curve-fit-1">
  517     <title>The first step of the &non-linear-curve-fit-cmd; dialog box.</title>
  518     <informalexample>
  519       <para>This first step is used to define the function which will be used for the fitting</para>
  520     </informalexample>
  521     <mediaobject> 
  522       <imageobject>
  523         <imagedata  format="PNG" fileref="pics/fit-dialog1.png"/>
  524       </imageobject>
  525     </mediaobject>
  526   </figure>
  527   <para>The second step is to define the parameters for the fit. You have to give initial guess for the fitting parameters.</para>
  528   <figure id="fig-non-linear-curve-fit-2">
  529     <title>The second step of the &non-linear-curve-fit-cmd; dialog box.</title>
  530     <informalexample>
  531       <para>This second step is used to define the parameters of the fitting</para>
  532     </informalexample>
  533     <mediaobject> 
  534       <imageobject>
  535         <imagedata  format="PNG" fileref="pics/fit-dialog2.png"/>
  536       </imageobject>
  537     </mediaobject>
  538   </figure>
  539   <para> In this second tab you can also choose a weighting method for your fit (the default is <emphasis>No weighting</emphasis>). The available weighting methods are:</para>
  540       <orderedlist>
  541       <listitem>
  542        <para><emphasis>Instrumental</emphasis>: the values of the associated error bars are used as weighting coefficients. You must add Y-error bars to the analyzed curve before performing the fit.</para>
  543       </listitem>
  544       <listitem>
  545         <para><emphasis>Statistical</emphasis>: the weighting coefficients are calculated as the square-roots of each data point in the fitted curve.</para>
  546       </listitem>
  547       <listitem>
  548         <para><emphasis>Arbitrary Dataset</emphasis>: you have the possibility to set the weighting coefficients using an arbitrary data set. The column used for the weighting must have a number of rows equal to the number of points in the fitted curve. </para>
  549       </listitem>
  550     </orderedlist>
  551   <para>After the fit, the log window is opened to show the results of the fitting process.</para>
  552   <para>Depending on the settings in the <emphasis>Custom Output</emphasis> tab, a function curve (option <emphasis>Uniform X Function</emphasis>) or a new table (if you choose the option <emphasis>Same X as Fitting Data</emphasis>) will be created for each fit. The new table includes all the X and Y values used to compute and to plot the fitted function and is hidden by default, but it can be found and viewed with the <link linkend="project-explorer-dialog">project explorer</link>.</para>
  553 </sect1>
  554 
  555 <!-- ************************************************** -->
  556 <!--        General Plot Options            -->
  557 <!-- ************************************************** -->
  558 <sect1 id="plot-options-dialog">
  559   <title>General Plot Options</title>
  560   <indexterm><primary>Plot</primary><secondary>Properties</secondary></indexterm>
  561   <para>The first tab is used to set the general scales used for the two or three axis.</para>
  562   <figure id="fig-plot-options-1-dialog">
  563     <title>General plot options dialog: the scale tab.</title>
  564     <mediaobject> 
  565       <imageobject>
  566         <imagedata  format="PNG" fileref="pics/plot-options-1.png"/>
  567       </imageobject>
  568     </mediaobject>
  569   </figure>
  570   <para>In this tab, you can also set the number of ticks used for each axis. This can be done in two ways: you can set the number of labels which are used for the whole scale. Whatever the number you enter, &appname; will use a value which leads to a pretty plot: for example, if you enter 7 ticks for a 0..100 scale, &appname; will use 10 major ticks from 10 to 10. If you want to fix non classical values, you can select the step method.</para>
  571   <para>The grid tab is used to draw grid lines on the plot. The frequency of the lines are related to the number of label and major ticks set with the <emphasis>Scale</emphasis> tab.</para>
  572   <figure id="fig-plot-options-2-dialog">
  573     <title>General plot options dialog: the grid tab.</title>
  574     <mediaobject> 
  575       <imageobject>
  576         <imagedata  format="PNG" fileref="pics/plot-options-2.png"/>
  577       </imageobject>
  578     </mediaobject>
  579   </figure>
  580   <para>The third tab is used to modify the setting of the different axis. You must select the axis that must be customized in the right window. The label of the axis can be modified in the title window, see the <link linkend="text-options-dialog">text options dialog</link> section for more details.</para>
  581   <figure id="fig-plot-options-3-dialog">
  582     <title>General plot options dialog: the axis tab.</title>
  583     <mediaobject> 
  584       <imageobject>
  585         <imagedata  format="PNG" fileref="pics/plot-options-3.png"/>
  586       </imageobject>
  587     </mediaobject>
  588   </figure>
  589   <para>The <emphasis>General</emphasis> settings tab is used to customize the global aspect of the plot. The canvas is the area defined by the axis, you can draw a box around this canvas and define a background color for this canvas. The background area is the global drawing area, you can also define a color border and a background color for this area. The margin parameter controls the distance between the drawing area limit and the canvas. If you want to modify the margin between the window limits and the drawing area, you must modify the layer parameters (manually with the mouse or with the <link linkend="arrange-layers-dialog">arrange layers dialog</link>.</para>
  590   <figure id="fig-plot-options-4-dialog">
  591     <title>General plot options dialog: General settings.</title>
  592     <mediaobject> 
  593       <imageobject>
  594         <imagedata  format="PNG" fileref="pics/plot-options-4.png"/>
  595       </imageobject>
  596     </mediaobject>
  597   </figure>
  598   <para>The parameters in the <emphasis>Axes</emphasis> group allow to modify the linestyle of the axes and of the ticks.</para>
  599 </sect1>
  600 
  601 <!-- ************************************************** -->
  602 <!--        Plot Wizard             -->
  603 <!-- ************************************************** -->
  604 <sect1 id="plot-wizard-dialog">
  605   <title>Plot Wizard</title>
  606   <indexterm><primary>Plot</primary><secondary>Create with the assistant</secondary></indexterm>
  607   <para>This dialog is activated by selecting the command <link linkend="plot-wizard-cmd">&plot-wizard-cmd;</link> from the <link linkend="sec-view-menu">View Menu</link> or with the &plot-wizard-key; key. This command is always active.</para>
  608   <para>This dialog is used to build a new plot by selecting the columns in the tables available in the current project. At first, you have to select the table you want to use, and then click on <emphasis>New curve</emphasis> to create the curve. After that, you have to select at least one column for X and one for Y. You can also select one more column for X-errors or for Y-errors. The plot created will have the default style you defined using the <link linkend="preferences-dialog">Preferences dialog</link> through the '2D Plots -> Curves' tab.</para>
  609   <figure id="fig-plot-wizard">
  610     <title>The plot wizard dialog box.</title>
  611     <informalexample>
  612       <para>In this example, one curve is selected from the first table, and the other from the second table (with X error bars)</para>
  613     </informalexample>
  614     <mediaobject> 
  615       <imageobject>
  616         <imagedata  format="PNG" fileref="pics/plot-wizard.png"/>
  617       </imageobject>
  618     </mediaobject>
  619   </figure>
  620 </sect1>
  621 
  622 <!-- ************************************************** -->
  623 <!--        Project Explorer            -->
  624 <!-- ************************************************** -->
  625 <sect1 id="project-explorer-dialog">
  626   <title>Project Explorer</title>
  627   <indexterm><primary>Project explorer</primary></indexterm>
  628   <para>The project explorer shows a list of all the windows, tables, matrices and folders which are included in the current project. It can be used to create new folders and windows, to find existing ones, to make hidden elements visible, to perform basic operations like: renaming, deleting, hiding, resizing, printing, etc... You can also use it in order to display the list of dependencies and properties of an element in the project.</para>
  629   <figure id="fig-project-explorer-1">
  630     <title>The project explorer panel.</title>
  631     <mediaobject> 
  632       <imageobject>
  633         <imagedata  format="PNG" fileref="pics/explorer1.png"/>
  634       </imageobject>
  635     </mediaobject>
  636   </figure>
  637 </sect1>
  638 
  639 <!-- ************************************************** -->
  640 <!--        Preferences Dialog          -->
  641 <!-- ************************************************** -->
  642 <sect1 id="preferences-dialog">
  643   <title>Preferences Dialog</title>
  644   <indexterm><primary>Options</primary></indexterm>
  645   <para>The preference dialog is used to customize the application. It has six different tabs. If you confirm your changes to the default behaviour of the application, the changes are saved and stored immediately.</para>
  646   <para>The first icon can be selected to change the <emphasis>General</emphasis> options of the application. In the first tab:  <emphasis>Application</emphasis>, the style is the general decoration used for the windows. It defines the aspect of the buttons and dialog boxes, as an example all screenshots presented in this manual have been done with the Keramik style available in KDE. The available styles are part of the Qt library. The font is the general font used for the GUI (menus, dialogs, etc), it doesn't apply to the plots. You can select the language of the application in the corresponding combo-box. All the available translations can be downloaded from the following address: <ulink url="http://soft.proindependent.com/translations.html">http://soft.proindependent.com/translations.html</ulink> and must be placed in a folder called <emphasis>translations</emphasis>, situated in the same location as the &appname; executable, in order to be loaded by the application.</para>
  647   <figure id="fig-preferences-dialog-1">
  648     <title>The preferences dialog: general parameters for the application.</title>
  649     <mediaobject> 
  650       <imageobject>
  651         <imagedata  format="PNG" fileref="pics/preferences-dialog1.png"/>
  652       </imageobject>
  653     </mediaobject>
  654   </figure>
  655   <para>The second tab of the <emphasis>General</emphasis> option set is used to disable the prompting on deleting of objects.</para>
  656   <informalfigure id="fig-preferences-dialog-2">
  657     <mediaobject> 
  658       <imageobject>
  659         <imagedata  format="PNG" fileref="pics/preferences-dialog2.png"/>
  660       </imageobject>
  661     </mediaobject>
  662   </informalfigure>
  663   <para>In this tab, you can change the default color for the workspace of the application. You can also choose the background color and the text color for panels. The panels are the <link linkend="sec-intro-log-window">Log Window</link> and the <link linkend="project-explorer-dialog">Project explorer</link>.</para>
  664   <informalfigure id="fig-preferences-dialog-3">
  665     <mediaobject> 
  666       <imageobject>
  667         <imagedata  format="PNG" fileref="pics/preferences-dialog3.png"/>
  668       </imageobject>
  669     </mediaobject>
  670   </informalfigure>
  671   <para>The second set of option allows to customize the default aspect of <link linkend="sec-intro-table">tables</link>: background and text colors, and fonts for tables and labels.</para>
  672   <indexterm><primary>Plot</primary><secondary>Change default options</secondary></indexterm>
  673   <indexterm><primary>Surface plot</primary><secondary>Change default options</secondary></indexterm>
  674   <figure id="fig-preferences-dialog-4">
  675     <title>The preferences dialog: table options.</title>
  676     <mediaobject> 
  677       <imageobject>
  678         <imagedata  format="PNG" fileref="pics/preferences-dialog4.png"/>
  679       </imageobject>
  680     </mediaobject>
  681   </figure>
  682   <para>The second set of options is used to customize the default aspect of <emphasis>2D plots</emphasis>. The first tab is used to modify general options.</para>
  683   <figure id="fig-preferences-dialog-5">
  684     <title>The preferences dialog: 2D plot options.</title>
  685     <mediaobject>
  686       <imageobject>
  687         <imagedata  format="PNG" fileref="pics/preferences-dialog5.png"/>
  688       </imageobject>
  689     </mediaobject>
  690   </figure>
  691   <para>The second tab named <emphasis>Curves</emphasis> defines the default style used when you create a new plot.</para>
  692   <informalfigure id="fig-preferences-dialog-6">
  693     <mediaobject>
  694       <imageobject>
  695         <imagedata  format="PNG" fileref="pics/preferences-dialog6.png"/>
  696       </imageobject>
  697     </mediaobject>
  698   </informalfigure>
  699   <para>The third tab named <emphasis>Ticks</emphasis> defines the default style for the ticks of the axes used when you create a new plot.</para>
  700   <informalfigure id="fig-preferences-dialog-7">
  701     <mediaobject>
  702       <imageobject>
  703         <imagedata  format="PNG" fileref="pics/preferences-dialog7.png"/>
  704       </imageobject>
  705     </mediaobject>
  706   </informalfigure>
  707   <para>The fourth tab named <emphasis>Fonts</emphasis> defines the default style for the fonts used for the axes, used when you create a new plot.</para>
  708   <informalfigure id="fig-preferences-dialog-8">
  709     <mediaobject>
  710       <imageobject>
  711         <imagedata  format="PNG" fileref="pics/preferences-dialog8.png"/>
  712       </imageobject>
  713     </mediaobject>
  714   </informalfigure>
  715   <figure id="fig-preferences-dialog-9">
  716     <title>The preferences dialog: 3D plot options.</title>
  717     <mediaobject> 
  718       <imageobject>
  719         <imagedata  format="PNG" fileref="pics/preferences-dialog9.png"/>
  720       </imageobject>
  721     </mediaobject>
  722   </figure>
  723   <figure id="fig-preferences-dialog-10">
  724     <title>The preferences dialog: fitting options.</title>
  725     <mediaobject> 
  726       <imageobject>
  727         <imagedata  format="PNG" fileref="pics/preferences-dialog10.png"/>
  728       </imageobject>
  729     </mediaobject>
  730   </figure>
  731 </sect1>
  732 
  733 <!-- ************************************************** -->
  734 <!--        Printer setup               -->
  735 <!-- ************************************************** -->
  736 <sect1 id="printer-setup-dialog">
  737   <title>Printer-setup</title>
  738   <indexterm><primary>Printing</primary></indexterm>
  739   <para>This dialog box is opened by the &print-lnk; from the &file-menu-lnk;. It is used to print the selected window (plot or table) and its aspect depends on your operating system. The following screenshot shows this dialog on a Linux system using the KDE window manager.</para>
  740   <figure id="fig-printer-setup">
  741     <title>The &print-cmd; dialog.</title>
  742     <mediaobject> 
  743       <imageobject>
  744         <imagedata  format="PNG" fileref="pics/dialog-print-setup-plot.png"/>
  745       </imageobject>
  746     </mediaobject>
  747   </figure>
  748 </sect1>
  749 
  750 <!-- ************************************************** -->
  751 <!--        Set Column Values           -->
  752 <!-- ************************************************** -->
  753 <sect1 id="set-column-values-dialog">
  754   <title>Set Column Values</title>
  755       <indexterm><primary>Table</primary><secondary>Columns</secondary><tertiary>Fill with values</tertiary></indexterm>
  756   <para>This dialog is activated by the &set-column-values-lnk; of the &table-menu-lnk;. It allows to fill a column with the result of a function.</para>
  757   <para>The available mathematical functions (assuming you are using the default scripting language, muParser) are listed in the <link linkend= "sec-muParser">appendix</link>. The special function <emphasis>col(x)</emphasis> can be used to access to the values of the column x, where x can be the column's number (as in <emphasis>col(2)</emphasis>) or its name in doublequotes (as in <emphasis>col("time")</emphasis>).
  758   You can also get values from other tables using the function <emphasis>tablecol(t,c)</emphasis>, where t is the table's name in doublequotes and c is the column's number or name in double quotes (example: <emphasis>tablecol("Table1","time")</emphasis>).</para>
  759   <para>The variables <code>i</code> and <code>j</code> can be used to access the current row and column numbers.
  760       Similarly, <code>sr</code> and <code>er</code> represent the selected start and end row, respectively.
  761   </para>
  762   <para>Using Python as scripting language gives you even more possibilities, since you can not only use arbitrary Python code in the function body, but also access other objects within your project. For details, see <link linkend="Python">here</link>.</para>
  763 
  764   <figure id="fig-sec-column-values">
  765     <title>The &set-column-values-cmd; dialog.</title>
  766     <mediaobject> 
  767       <imageobject>
  768         <imagedata  format="PNG" fileref="pics/set-column-values-dialog.png"/>
  769       </imageobject>
  770     </mediaobject>
  771   </figure>
  772 
  773   <para>If you make some changes in the table, the values are not computed again.
  774       You have to explicitly tell &appname; to recalculate individual cells or whole columns or rows by selecting "Recalculate" from their context menu or pressing Control+Return.
  775   </para>
  776 
  777 </sect1>
  778 
  779 <!-- ************************************************** -->
  780 <!--        Set Dimensions              -->
  781 <!-- ************************************************** -->
  782 <sect1 id="set-dimensions-dialog">
  783   <title>&set-dimensions-cmd;</title>
  784       <indexterm><primary>Matrix</primary><secondary>Dimensions</secondary></indexterm>
  785   <para>This command is in the &matrix-menu-lnk;. It allows to specify the number of rows and columns of a matrix</para>
  786   <para>In this window, you can also define X-values and Y-values. These X and Y ranges will only be used by the 3D-plot, they are not known if you choose to define the content of the matrix with the <link linkend="set-values-dialog">Set Values Dialog</link>.</para>
  787   <figure id="fig-set-dimensions-dialog">
  788     <title>The &set-dimensions-cmd; dialog for matrix.</title>
  789     <mediaobject> 
  790       <imageobject>
  791         <imagedata  format="PNG" fileref="pics/matrix-set-dimensions.png"/>
  792       </imageobject>
  793     </mediaobject>
  794   </figure>
  795 </sect1>
  796 
  797 <!-- ************************************************** -->
  798 <!--        Import ASCII files          -->
  799 <!-- ************************************************** -->
  800 <sect1 id="set-import-options-dialog">
  801   <title>Set options for Importation of ASCII files.</title>
  802   <titleabbrev>ASCII Import options</titleabbrev>
  803   <indexterm><primary>Table</primary><secondary>Import from file</secondary></indexterm>
  804   <indexterm><primary>Matrix</primary><secondary>Import from file</secondary></indexterm>
  805   <para>This dialog is activated by selecting the command <link linkend="set-import-options-cmd">&set-import-options-cmd;</link> from the <link linkend="sec-file-menu">File Menu</link>.</para>
  806   <para>This dialog is used to set the options which are used for the importation of ASCII data files by the commands <link linkend="import-ascii-1-cmd">&import-ascii-1-cmd;</link> and <link linkend="import-ascii-n-cmd">&import-ascii-n-cmd;</link>.</para>
  807   <figure id="fig-set-import-options">
  808     <title>The &set-import-options-cmd; dialog box.</title>
  809     <mediaobject> 
  810       <imageobject>
  811         <imagedata  format="PNG" fileref="pics/set-import-options.png"/>
  812       </imageobject>
  813     </mediaobject>
  814   </figure>
  815   <para>The first parameter is the separator which is used between the columns. The second allows to skip the n first lines of the file.</para>
  816   <itemizedlist>
  817     <listitem>
  818       <para>If you choose to use the first line as column names, you must use the same separator between the column names and between the data columns.</para>
  819     </listitem>
  820     <listitem>
  821       <para>There is no grouping of separators, so if you use "SPACE", you must put only <emphasis>one</emphasis> separator between each column.</para>
  822     </listitem>
  823   </itemizedlist>
  824 </sect1>
  825 
  826 <!-- ************************************************** -->
  827 <!--        Set Properties              -->
  828 <!-- ************************************************** -->
  829 <sect1 id="set-properties-dialog">
  830   <title>&set-properties-cmd;</title>
  831   <indexterm><primary>Matrix</primary><secondary>Properties</secondary></indexterm>
  832   <para>This command is in the &matrix-menu-lnk;. It allows to specify some global properties of the selected matrix such as the cell width (in pixels) and the format for numbers.</para>
  833   <figure id="fig-set-properties-dialog">
  834     <title>The &set-properties-cmd; dialog for matrix.</title>
  835     <mediaobject> 
  836       <imageobject>
  837         <imagedata  format="PNG" fileref="pics/matrix-set-properties.png"/>
  838       </imageobject>
  839     </mediaobject>
  840   </figure>
  841 </sect1>
  842 
  843 <!-- ************************************************** -->
  844 <!--        Set Values              -->
  845 <!-- ************************************************** -->
  846 <sect1 id="set-values-dialog">
  847   <title>&set-values-cmd;</title>
  848       <indexterm><primary>Matrix</primary><secondary>Fill with a function</secondary></indexterm>
  849   <para>This command is in the &matrix-menu-lnk;. It allows to fill in a matrix with the results of a function z=f(i,j) in which i and j are the row and column numbers.</para>
  850   <para>Even if you have defined X-values and Y-values with the &set-dimensions-lnk; command, you must use i and j as parameters for the function. In the example below, X and Y ranges have been defined as 101 values ( i and j from 1 to 101) between -5 and +5. Therefore, the function uses as entries the parameters x=(j-1)/100-5 and y=(i-1)/100-5.</para>
  851   <para>The functions can be written on several lines, and the intrinsic functions which are available are listed in the <link linkend="sec-muParser">appendix</link> .</para>
  852   <figure id="fig-set-values-dialog">
  853     <title>The &set-values-cmd; dialog for matrix.</title>
  854     <mediaobject> 
  855       <imageobject>
  856         <imagedata  format="PNG" fileref="pics/matrix-set-values.png"/>
  857       </imageobject>
  858     </mediaobject>
  859   </figure>
  860 </sect1>
  861 
  862 <!-- ************************************************** -->
  863 <!--        Surface plot options            -->
  864 <!-- ************************************************** -->
  865 <sect1 id="surface-plot-options-dialog">
  866   <title>Surface plot options</title>
  867   <indexterm><primary>Surface plot</primary><secondary>Properties</secondary></indexterm>
  868   <para>This dialog box is used to customize a 3D function plot which has been created by the &new-surface-3d-plot-lnk; from the &file-menu-lnk;. It is activated by a double click on the 3D plot.</para>
  869 
  870   <para>The first tab is used to modify the X, Y and Z ranges. It allows also to specify the number of labels on the axis and the number of secondary ticks.</para>
  871   <figure id="fig-surface-plot-options-1">
  872     <title>The surface plot options dialog box.</title>
  873     <mediaobject> 
  874       <imageobject>
  875         <imagedata  format="PNG" fileref="pics/surface-plot-options-dialog1.png"/>
  876       </imageobject>
  877     </mediaobject>
  878   </figure>
  879   <para>The second tab defines the main parameters of the three axis: the axis label and its font, and the length of the ticks. This length is defined in the same units as the range of the axis. If something is changed in the scales of the graph, the length of the ticks is re-calculated by &appname;. The font button allows to modify only the font used for the label, if you want to customize the font of the numbers used for the axis, you must used the fifth tab.</para>
  880   <informalfigure id="fig-surface-plot-options-2">
  881     <mediaobject> 
  882       <imageobject>
  883         <imagedata  format="PNG" fileref="pics/surface-plot-options-dialog2.png"/>
  884       </imageobject>
  885     </mediaobject>
  886   </informalfigure>
  887   <para>The third tab is used to define or modify the title of the plot. You can not add subscripts/superscripts, bold characters, etc in your title as you can do it for 2D plots.</para>
  888   <informalfigure id="fig-surface-plot-options-3">
  889     <mediaobject> 
  890       <imageobject>
  891         <imagedata  format="PNG" fileref="pics/surface-plot-options-dialog3.png"/>
  892       </imageobject>
  893     </mediaobject>
  894   </informalfigure>
  895   <para>The fourth tab allows to modify the colors used in the different elements of the plot.</para>
  896   <informalfigure id="fig-surface-plot-options-4">
  897     <mediaobject> 
  898       <imageobject>
  899         <imagedata  format="PNG" fileref="pics/surface-plot-options-dialog4.png"/>
  900       </imageobject>
  901     </mediaobject>
  902   </informalfigure>
  903   <para>The first set of two colors (data min and data max) defines the color scheme which is used to show the Z-values. They are the colors used for the minimum value of Z (Z<subscript>min</subscript>) and the maximum value of Z (Z<subscript>max</subscript>). We can define the colors by their Red, Green and Blue parameters: [R,G,B]. Then, a value Z will be represented by a color defined as a linear interpolation:</para>
  904   <informalequation> 
  905   <mediaobject>
  906     <imageobject>
  907       <imagedata  format="PNG" fileref="equations/equation_couleur.png"/>
  908     </imageobject>
  909   </mediaobject>
  910   </informalequation>
  911   <para>The default colors for Z<subscript>min</subscript> and Z<subscript>max</subscript> are respectively blue ( [R,G,B] = [0,0,255] ) and red ( [R,G,B] = [255,0,0] ). This lead to the following color scheme:</para>
  912 
  913   <informalfigure id="fig-default-color-scheme">
  914     <mediaobject> 
  915       <imageobject>
  916         <imagedata  format="PNG" fileref="pics/default-color-scheme.png"/>
  917       </imageobject>
  918     </mediaobject>
  919   </informalfigure>
  920 
  921 <para>Another classical color scheme can be built with Z<subscript>min</subscript> = [160,32,32] and Z<subscript>max</subscript> = [255,255,0] (yellow). It leads to:</para>
  922 
  923   <informalfigure id="fig-color-scheme-1">
  924     <mediaobject> 
  925       <imageobject>
  926         <imagedata  format="PNG" fileref="pics/color-scheme-1.png"/>
  927       </imageobject>
  928     </mediaobject>
  929   </informalfigure>
  930 
  931   <para>Another way to define colors is to read a colormap from a file. The format of the file is simple: each line defines a color by red, green and blue values as integers between 0 and 255. The numbers should be separated by spaces. The colors defined in this way are distributed equidistantly between minimum and maximum Z value, such that the first reference point is at Z<subscript>min</subscript>, the last reference point at Z<subscript>max</subscript> and each color is applied to all points with Z values between its own reference point (inclusively) and the next one (exclusively). You can find several examples of colormaps on the <ulink url="http://sourceforge.net/project/showfiles.php?group_id=78209">QwtPlot3D web site</ulink> (section misc, file qwtplot3d-colormaps.tgz).</para>
  932 
  933 <para>The last tab is used to define some global parameters and the aspect ratio of the plot. The default behaviour is to use the perspective to compute the 3D plot. If you choose to check the <emphasis>Orthogonal</emphasis> check box, the plot will use vertical Z axis whatever the view angle of the plot.</para>
  934 <indexterm><primary>Surface plot</primary><secondary>Options</secondary></indexterm>
  935   <figure id="fig-surface-plot-options-5">
  936     <title>The surface plot options dialog box with tab 5: aspect ratio.</title>
  937     <mediaobject> 
  938       <imageobject>
  939         <imagedata  format="PNG" fileref="pics/surface-plot-options-dialog5.png"/>
  940       </imageobject>
  941     </mediaobject>
  942   </figure>
  943 </sect1>
  944 
  945 
  946 <!-- ************************************************** -->
  947 <!--        Text options                -->
  948 <!-- ************************************************** -->
  949 <sect1 id="text-options-dialog">
  950   <title>Text options</title>
  951   <indexterm><primary>Text label</primary><secondary>Properties</secondary></indexterm>
  952   <para>This dialog can be opened by several commands such as &format-title-lnk; or when you double click on a text object in your plot. It allows to add/customize the text objects.</para>
  953   <figure id="fig-text-options">
  954     <title>The text options dialog.</title>
  955     <mediaobject> 
  956       <imageobject>
  957         <imagedata  format="PNG" fileref="pics/text-options-dialog.png"/>
  958       </imageobject>
  959     </mediaobject>
  960   </figure>
  961   <para>The <emphasis>Color</emphasis>, <emphasis>Font</emphasis> and <emphasis>Alignment</emphasis> commands allow the modification of the general settings of the text label.</para>
  962   <para>The text item can be modified in the text window. Several improvements can be added to the text:</para>
  963   <itemizedlist>
  964     <listitem><para>&lt;sub&gt;text&lt;/sub&gt; will draw the text as subscripts. You can insert this sequence by clicking on the <inlinemediaobject><imageobject><imagedata  format="PNG" fileref="pics/text-options-icon1.png"/></imageobject></inlinemediaobject>.</para></listitem>
  965     <listitem><para>&lt;sup&gt;text&lt;/sup&gt; will draw the text as superscripts. You can insert this sequence by clicking on the <inlinemediaobject><imageobject><imagedata  format="PNG" fileref="pics/text-options-icon2.png"/></imageobject></inlinemediaobject>.</para></listitem>
  966     <listitem><para>By clicking on the <inlinemediaobject><imageobject><imagedata  format="PNG" fileref="pics/text-options-icon3.png"/></imageobject></inlinemediaobject>, you can open a new dialog which allows to select Greek characters:</para>
  967     <informalfigure id="fig-text-options1">
  968       <mediaobject> 
  969         <imageobject>
  970           <imagedata  format="PNG" fileref="pics/text-options-dialog1.png"/>
  971         </imageobject>
  972       </mediaobject>
  973     </informalfigure>
  974     </listitem>
  975     <listitem><para>By clicking on the <inlinemediaobject><imageobject><imagedata  format="PNG" fileref="pics/text-options-icon4.png"/></imageobject></inlinemediaobject>, you can open a new dialog which allows to select various mathematical symbols:</para>
  976     <informalfigure id="fig-text-options2">
  977       <mediaobject> 
  978         <imageobject>
  979           <imagedata  format="PNG" fileref="pics/text-options-dialog2.png"/>
  980         </imageobject>
  981       </mediaobject>
  982     </informalfigure>
  983     </listitem>
  984     <listitem><para>&lt;b&gt;text&lt;/b&gt; will draw the text with bold characters. You can insert this sequence by clicking on the <inlinemediaobject><imageobject><imagedata  format="PNG" fileref="pics/text-options-icon5.png"/></imageobject></inlinemediaobject>.</para></listitem>
  985     <listitem><para>&lt;i&gt;text&lt;/i&gt; will draw the text with italic characters. You can insert this sequence by clicking on the <inlinemediaobject><imageobject><imagedata  format="PNG" fileref="pics/text-options-icon6.png"/></imageobject></inlinemediaobject>.</para></listitem>
  986     <listitem><para>&lt;u&gt;text&lt;/u&gt; will draw the text with underlined characters. You can insert this sequence by clicking on the <inlinemediaobject><imageobject><imagedata  format="PNG" fileref="pics/text-options-icon7.png"/></imageobject></inlinemediaobject>.</para></listitem>
  987   </itemizedlist>
  988 
  989 </sect1>