doc/salome/gui/VISU/input/scalar_map.doc

   1 /*!
   2
   3 \page scalar_map_page Scalar Map presentation
   4
   5 \n <b>Scalar Map</b> is the basic type of visualization of calculation
   6 data in \b Post-Pro module. This presentation consists of the
   7 following:
   8 <ul>
   9 <li>creating a 3D presentation on the basis of a field:</li>
  10 <ul>
  11 <li>on the whole mesh (default)</li>
  12 <li>on group(s) of the mesh</li>
  13 </ul>
  14 <li>coloring the cells of this presentation, according the scalar or
  15 vector values applied to this cells;</li>
  16 <li>creating a scalar bar representing the correspondence  between the
  17 scalar values of the field and the used colors.</li>
  18 </ul>
  19
  20 All other types of field presentations are based on the <b>Scalar Map</b>.
  21
  22 <em>To create a Scalar Map presentation:</em>
  23 \par
  24 &ndash; Right-click on one of the time stamps of the field in the Object
  25 browser and from the pop-up menu choose <b>Scalar Map</b>, or
  26 <br>
  27 &ndash; Click on one of the time stamps of the field in the Object browser
  28 and select from the main menu <b>Visualization > Scalar Map</b>, or
  29 click <em>"Scalar Map"</em> icon in the <b>Visualization
  30 Toolbar</b>
  31
  32 \image html scalarmapicon.jpg
  33 <center><em>"Scalar Map" icon</em></center>
  34
  35 \par
  36 The following dialog box will appear:
  37
  38 \image html scalarbarproperties.png
  39
  40 \note This dialog box is equal for all types of field presentations
  41 and it will be present as an additional tab in all dialog boxes
  42 allowing to create the other types of presentations. It allows to set
  43 the parameters of <b>Scalar range</b>, as well as the parameters of
  44 the <b>Scalar Bar</b>. You can also set these parameters as
  45 preferences which will be used in all SALOME sessions: in the main
  46 menu select <b>File > Preferences > Post Pro > Scalar Bar</b>.
  47
  48 \par
  49 <br>
  50 <ul>
  51 <li><b>Build presentation on groups:</b> You can choose the groups on
  52 which <b>Scalar Map</b> can be built from the list to the left and add
  53 them in the list to the right.</li>
  54 <li><b>Scalar range parameters:</b></li>
  55 <ul>
  56 <li><b>Scalar Mode</b> field: This field allows to choose the mode of
  57 transformation of vector values into scalar values for creation of the
  58 presentation. It can be module of the vector or one of three
  59 components of the vector. (Note: This choose box is relevant only for
  60 fields containing vector values, in other cases it will be
  61 inactive).</li>
  62 <li><b>Logarithmic scaling</b> check box: You can apply logarithmic
  63 scaling to the color scale of the presentation.</li>
  64 <li><b>Use field range:</b> if this check box is selected, all cells
  65 of the field presentation will be colored according the values applied
  66 to these cells.</li>
  67 <li><b>Use imposed range:</b> here you can define your own range of
  68 scalar values of the field, on the basis of which this presentation
  69 will be constructed. The cells of the field presentation with applied
  70 scalar or vector values belonging to this imposed range will be
  71 colored according to these values. The other cells of the field
  72 presentation (with applied scalar or vector values out of this imposed
  73 range) will be displayed using one color. For the cells with applied
  74 scalar or vector values, which are less than the minimal value of the
  75 imposed range, the color will be the same as for the cells with
  76 applied minimal values. For the cells with applied scalar or vector
  77 values, which are larger than the maximal value of the imposed range
  78 the color will be the same as for the cells with applied minimal
  79 values.</li>
  80 </ul>
  81 <li><b>Colors and Labels:</b></li>
  82 <ul>
  83 <li><b>Nb. of colors</b> field: In this field you can enter the number
  84 of colors, which will be used for coloring of cells containing scalar
  85 values.</li>
  86 <li><b>Nb. of labels</b> field: In this field you can enter the number
  87 of labels, indicating graduation of the scalar bar.</li>
  88 </ul>
  89 <li><b>Orientation:</b> You can select \b Vertical or \b Horizontal
  90 orientation of the scalar bar.</li>
  91 <li><b>Origin:</b> you can enter X & Y coordinates of the origin of
  92 the scalar bar.</li>
  93 <li><b>Dimensions:</b> you can enter \b Width and \b Height of the
  94 scalar bar.</li>
  95 <li><b>Text properties</b> button allows you to define from the
  96 following dialog box:
  97
  98 \image html textproperty.png
  99
 100 <ul>
 101 <li>\b Title of the field, on the basis of which this presentation is
 102 created,</li>
 103 <li>Font properties of the \b Title, displayed in the Viewer,</li>
 104 <li>Font properties of the \b Labels, displayed in the Viewer.</li>
 105 </ul>
 106 </li>
 107 <li><b>Bar properties</b> button allows you to define from the
 108 following dialog box:
 109
 110 \image html barproperty.png
 111
 112 <ul>
 113 <li>Relative \b width and \b height of \b Title (in percents),</li>
 114 <li>Relative \b width and \b height of \b Labels (in percents),</li>
 115 <li>Relative \b width and \b height of \b Bar (in percents),</li>
 116 <li>Visibility of \b Units in \b Title,</li>
 117 <li>Format of \b Labels.</li>
 118 </ul>
 119 </li>
 120 </ul>
 121
 122 After you have finished with setting these parameters, click \b
 123 OK. Your presentation with scalar bar will be immediately displayed in
 124 the viewer:
 125
 126 \image html scalarrangesn.png
 127
 128 */