Geografic-Information-System/gui/wxpython/docs/wxGUI.html

<h2>DESCRIPTION</h2>

<b>wxGUI</b> is a new generation of the GUI for GRASS GIS. It's a successor
of the <em>Tcl/Tk GUI</em> from GRASS 6.

<p>
If wxGUI is not your default GUI, you can define it as default by
typing at GRASS command line prompt

<div class="code"><pre>
   g.gui -u wxpython 
</pre></div>

or define in your <tt>.grassrc7</tt> file 'GRASS_GUI' variable

<div class="code"><pre>
    GRASS_GUI: gui
</pre></div>

The GUI can be quit by selecting the 'File->Exit' menu item. The GUI
can be restarted from the GRASS command line prompt by typing

<div class="code"><pre>
    g.gui
</pre></div>

or  to restart with previously saved workspace type:

<div class="code"><pre>
    g.gui workspace=file.gxw
</pre></div>

<p>
You can also start GRASS from the shell command line with wxGUI
defined by the <tt>-wxpython</tt> switch:

<div class="code"><pre>
    grass70 -wxpython
</pre></div>

<p>
The GUI is composed by <em>two</em> main components:

<ul>
  <li><b>Layer Manager</b> which allows users to run different GRASS
  modules from menu, includes map layer management, integrated
  command-line prompt, and command output window tab.</li>
  <li><b>Map Display Window</b> which integrates basic tools for
  zooming, panning, data querying, decorations (north arrows,
  barscale, etc.). The user is allowed to start various map display
  instances during one session. The Layer Manager registers Map
  Display Windows using different tabs.</li>
</ul>

<h3>Layer Manager</h3>

The <em>Layer Manager</em> provides an interactive graphical interface to GRASS
commands. It includes a set of pull-down menus for all GRASS GIS
functions (analysis, file I/O, GIS configuration and management), the
toolbar to manage display map layers, a layer tree frame in which map layers
to display are organized, command output window tab, and interactive
command line prompt.

<center>
<br><img src="wxGUI_layer_manager.jpg" border="1"><br><br>
</center>

The top left button of the toolbar opens a new <em>Map Display
Window</em>. Each map display has a unique set of layers to display
and region settings. Other toolbar buttons add layers of different
types for display in the selected map display window. There are
additional buttons for saving or opening workspace file, and others.

<p>
Map layers are listed in the window frame below the toolbar. Layers can
include raster and vector maps, text, map decorations (scale and
north arrow, and grids), and commands (where any GRASS command can be
written). Layers are displayed as arranged in the layer tree: the
bottom layer is displayed first and the top layer is displayed last, as if
the layers were a series of stacked overlays.

<p>
The check box to the left of each layer makes it active or inactive
for display. Only active layers are displayed/redisplayed when the
display button is pressed. Layers can be organized into groups; entire
groups can be activated or deactivated for display. Layer tree
composition can be saved to a workspace file and opened in subsequent
sessions, restoring all layers and their display options.

<p>
Right mouse click on a layer opens a dropdown menu with options to 
remove or rename the layer (g.remove, g.rename), 
change its display properties (d.rast and d.vect options such as color, symbol, etc.),
show its metadata (r.info, v.info) or attributes, if applicable.
<p>
Left mouse double click on a layer opens GUI for its display options (d.rast, d.vect).

<h4>Layer Manager Toolbar</h4>

New and old icons and explanation of their functionality:
<dl>

<dt><img src="icons/grass2/monitor-create.png">&nbsp;
  <img src="icons/grass/gui-startmon.gif">&nbsp;
<em>Open new Map Display Window</em></dt>
<dd>Opens a new map display and creates empty layer tree tab in Layer Manager.</dd>

<dt><img src="icons/grass2/create.png">&nbsp;
  <img src="icons/grass/file-new.gif">&nbsp;
<em>Creates new workspace file</em></dt>
<dd>Removes all layers in the layer tree and creates a new, empty tree
where new layers can be added.</dd>

<dt><img src="icons/grass2/layer-open.png">&nbsp;
  <img src="icons/grass/file-new.gif">&nbsp;
<em>Load map layers (raster, vector) into workspace</em></dt>
<dd>Loads selected raster or vector maps into current layer tree.</dd>

<dt><img src="icons/grass2/open.png">&nbsp;
  <img src="icons/grass/file-open.gif">&nbsp;
<em>Open an existing workspace file</em></dt>
<dd>Opens an previously saved workspace file, containing a set of display
layers and their option settings.</dd>

<dt><img src="icons/grass2/save.png">&nbsp;
  <img src="icons/grass/file-save.gif">&nbsp;
<em>Save workspace file</em></dt>
<dd>Saves current set of layers and their options to a workspace
  file.</dd>

<dt><img src="icons/grass2/layer-raster-add.png">&nbsp;
  <img src="icons/grass/element-cell.gif">&nbsp;
<em>Add raster map layer</em></dt>
<dd>Adds raster map to layer tree, see <em><a href="d.rast.html">d.rast</a></em>. 
</dd>

<dt><img src="icons/grass2/layer-shaded-relief-add.png">&nbsp;
  <img src="icons/grass/module-d.shadedmap.gif">&nbsp;
<em>Add various raster-based map layers</em></dt>
<dd>opens a dropdown menu that allows user to select to:<br> 

  <ul>
    <li><dt><img src="icons/grass2/layer-shaded-relief-add.png">&nbsp;
	<img src="icons/grass/module-d.shadedmap.gif">&nbsp;
	<em>Add shaded relief raster map layer </em></dt>
      <dd>Adds shaded relief raster map layer,
	see <em><a href="d.shadedmap.html">d.shadedmap</a></em></li>
    <li><dt><img src="icons/grass2/layer-rgb-add.png">&nbsp;
	<img src="icons/grass/channel-rgb.gif">&nbsp;
	<em>Add RGB raster layer</em></dt>
      <dd>Combines and displays three raster maps defined as red, green, and blue
	channels, see <em><a href="d.rgb.html">d.rgb</a></em>.</dd></li>
    <li><dt><img src="icons/grass2/layer-his-add.png">&nbsp;
	<img src="icons/grass/channel-his.gif">&nbsp;
	<em>Add HIS raster layer</em></dt>
      <dd>Combines and displays two or three raster maps defined as hue,
	intensity, and (optionally) saturation channels,
	see <em><a href="d.his.html">d.his</a></em>.</dd></li>
    <li><dt><img src="icons/grass2/layer-cell-cats-add.png">&nbsp;
	<img src="icons/grass/module-d.rast.arrow.gif">&nbsp;
	<em>Add raster arrows layer</em></dt>
      <dd>Adds map of raster cells with directional arrows drawn.  Arrow
	direction and length are determined by separate aspect/directional map
	and (optional) slope/intensity map,
	see <em><a href="d.rast.arrow.html">d.rast.arrow</a></em>.</dd></li>
    <li><dt><img src="icons/grass2/layer-cell-cats-add.png">&nbsp;
	<img src="icons/grass/module-d.rast.num.gif">&nbsp;
	<em>Add raster numbers layer</em></dt>
      <dd>Adds map of raster cells with numbers representing the cell values, 
	see <em><a href="d.rast.num.html">d.rast.num</a></em>.</dd></li>
  </ul>

<dt><img src="icons/grass2/layer-vector-add.png">&nbsp;
  <img src="icons/grass/element-vector.gif">&nbsp;
<em>Add vector map layer</em></dt>
<dd>Adds a vector map layer, see <em><a href="d.vect.html">d.vect</a></em>. 
</dd>

<dt><img src="icons/grass2/layer-vector-thematic-add.png">&nbsp;
  <img src="icons/grass/module-d.vect.thematic.gif">&nbsp;
<em>Add various vector-based map layers </em></dt>
<dd>opens a dropdown menu that allows user to select to:<br>

  <ul>
    <li><dt><img src="icons/grass2/layer-vector-thematic-add.png">&nbsp;
	<img src="icons/grass/module-d.vect.thematic.gif">&nbsp;
	<em>Add thematic map layer
	  (for all vector types)</em></dt>
      <dd>Adds layer for thematic display values from a numeric attribute
	column associated with a vector map. Options include: thematic display
	type (graduated colors or point sizes), methods for creating display
	intervals, SQL query of attribute column to limit vector objects to
	display, control of point icon types and sizes, control of thematic
	color schemes, creation of legend for thematic map, and saving the
	results of thematic mapping to a ps.map instructions file for later
	printing,
	see <em><a href="d.vect.thematic.html">d.vect.thematic</a></em>.</dd></li>
      
    <li><dt><img src="icons/grass2/layer-vector-chart-add.png">&nbsp;
	<img src="icons/grass/module-d.vect.chart.gif">&nbsp;
	<em>Add thematic charts layer (for vector points)</em></dt>
      <dd>Adds layer in which pie or bar charts can be automatically created
	at vector point locations. Charts display values from selected columns
	in the associated attribute table. Options include: chart type, layer
	and attributes to chart, chart colors, and chart size (fixed or based
	on attribute column),
	see <em><a href="d.vect.chart.html">d.vect.chart</a></em>.</dd></li>
  </ul>

<dt><img src="icons/grass2/layer-command-add.png">&nbsp;
  <img src="icons/grass/gui-cmd.gif">&nbsp;
<em>Add command layer</em></dt>
<dd>Adds a layer in which a GRASS GIS command or command list can be entered.
For a command list use the semi-colon (";") symbol as a separator.
For example:

<div class="code"><pre>
d.rast soils;d.rast -o roads;d.vect streams col=blue
</pre></div>

Note that when an option of the command contains spaces, you need to
"escape" them with the backslash ('\') character, for example:
<div class="code"><pre>
d.text text=Population\ density
</pre></div>
</dd>

<dt><img src="icons/grass2/layer-group-add.png">&nbsp;
  <img src="icons/grass/gui-group.gif">&nbsp;
<em>Add layer group</em></dt>
<dd>Adds an empty layer group. Layers can then be added to the group.</dd>

<dt><img src="icons/grass2/layer-grid-add.png">&nbsp;
  <img src="icons/grass/module-d.grid.gif">&nbsp;
   <em>Add grid or vector labels overlay</em></dt>
<dd>opens a dropdown menu that allows user to select to:<br>

<UL>
<LI><dt><img src="icons/grass2/layer-grid-add.png">&nbsp;
        <img src="icons/grass/module-d.grid.gif">&nbsp;
        <em>Add overlay grids and lines</em></dt>
        <dd>Adds layer to display regular grid (for all locations)
           see <em><a href="d.grid.html">d.grid</a></em></dd>

<LI><dt><img src="icons/grass2/layer-label-add.png">&nbsp;
        <img src="icons/grass/module-d.labels.gif">&nbsp;
        <em>Add labels layer for vector objects (from existing labels file)</em></dt>
        <dd>Add raster text layer from a labels file for vector objects
        created with the <em><a href="v.label.html">v.label</a></em> module
        (accessed from button in options panel). A labels file can also be
        created with a text editor, see <em><a href="d.labels.html">d.labels</a></em>.</dd>

<LI><dt><img src="icons/grass2/layer-grid-add.png">&nbsp;
        <img src="icons/grass/module-d.grid.gif">&nbsp;
        <em>Add geodesic line layer</em></dt>
        <dd>Add layer to display geodesic line for latitude/longitude locations only,
        see <em><a href="d.geodesic.html">d.geodesic</a></em></dd> 

<LI><dt><img src="icons/grass2/layer-grid-add.png">&nbsp;
        <img src="icons/grass/module-d.grid.gif">&nbsp;
        <em>Add rhumbline layer</em>
         <dd>Add layer to display rhumblines (for latitude/longitude locations only),
          see <em><a href="d.rhumbline.html">d.rhumbline</a></em>.</dd>
</UL>

<dt><img src="icons/grass2/layer-remove.png">&nbsp;
  <img src="icons/grass/edit-cut.gif">&nbsp;
   <em>Delete selected layer</em></dt>
<dd>Removes selected map layer or map layer group from layer tree.</dd>

<dt><img src="icons/grass2/table.png">&nbsp;
  <img src="icons/grass/db-values.gif">&nbsp;
  <em>Show <a href="wxGUI.Attribute_Table_Manager.html">Attribute Table Manager</a> for selected vector map</em></dt>
<dd>Displays attribute data of selected vector map.</dd>

</dl>

<h4>Key shortcuts</h4>

<b>Menu</b>
<dl>
  <dt>Ctrl+N</dt>
  <dd>Create new workspace</dd>
  <dt>Ctrl+O</dt>
  <dd>Load workspace from file</dd>
  <dt>Ctrl+S</dt>
  <dd>Save workspace</dd>
  <dt>Ctrl+C</dt>
  <dd>Close workspace</dd>
  <dt>Ctrl+Q</dt>
  <dd>Quit GUI</dd>
</dl>

<b>Global</b>
<dl>
  <dt>Alt+R</dt>
  <dd>Add raster map layer</dd>
  <dt>Alt+V</dt>
  <dd>Add vector map layer</dd>
</dl>

<h3>Map Display Window</h3>

This component includes toolbar area (set of toolbars), map canvas
where a map composition is displayed, and the statusbar.

<center>
  <br><img src="wxGUI_map_display.jpg" alt="Map Display Window"><br><br>
</center>

Each Map Display Window has a unique layer tree and region
setting. The window contains a toolbar with buttons to manage the map
in the display (zoom and pan), providing tools for query and distance
measurement, and exporting or printing the display.

<p>
In the statusbar can be displayed the geographic coordinates under the
cursor, current geographical region extent, computational region
(including graphical visualization in map display), map display
geometry (number of rows, columns, resolution) and map scale.

<p>
It is important to note that zooming in any display will
have <em>no</em> effect on the 'computational region' setting (set
with <em><a href="g.region.html">g.region</a></em>). Only by selecting
the 'Set current region to match display' item in the zoom menu (in
the map display toolbar) will the current display extents be copied to
the computational region extents.

<h4>Map Display Toolbar</h4>

<dl>

<dt><img src="icons/grass2/show.png">&nbsp;
  <img src="icons/grass/gui-display.gif">&nbsp;
  <img src="icons/silk/map_go.png"> <em>Display active layers (current region)</em></dt>
<dd>Displays all active layers from layer tree at current resolution
and region extents for that map display window.</dd>

<dt><img src="icons/grass2/layer-redraw.png">&nbsp;
  <img src="icons/grass/gui-redraw.gif">&nbsp;
  <img src="icons/silk/arrow_refresh.png"> <em>Re-render and display all active
layers and zoom to current region</em></dt>
<dd>Resets the region to the display resolution and extents and forces
re-display and re-rendering all active layers.</dd>

<dt><img src="icons/grass2/erase.png">&nbsp;
  <img src="icons/grass/gui-erase.gif">&nbsp;
  <img src="icons/silk/cross.png"> <em>Erase display content</em></dt>
<dd>Erases the currently selected map display to a white background;
also removes all frames,
see <em><a href="d.erase.html">d.erase</a>, <a href="d.frame.html">d.frame
-e</a></em>.</dd>

<dt><img src="icons/grass2/pointer.png">&nbsp;
  <img src="icons/grass/gui-pointer.gif">&nbsp;
  <img src="icons/silk/cursor.png"> <em>Arrow cursor</em></dt>
<dd>Select arrow cursor for map display.</dd>

<dt><img src="icons/grass2/info.png">&nbsp;
  <img src="icons/grass/gui-query.gif">&nbsp;
  <img src="icons/silk/information.png"> <em>Query tool (select a map first)</em></dt>
<dd>Query selected raster, RGB raster (all three map channels will be
queried), or vector map(s) using the mouse. Map(s) must be selected
before query.  Vector charts and thematic vector maps cannot be
queried. The results of the query will be displayed in the console
window,
see <em><a href="r.what.html">r.what</a>, <a href="v.what.html">v.what</a></em>.</dd>

<dt><img src="icons/grass2/pan.png">&nbsp;
  <img src="icons/grass/gui-pan.gif">&nbsp;
  <img src="icons/silk/arrow_out.png"> <em>Pan</em></dt>
<dd>Interactive selection of a new center of view in the active
display monitor. Drag the pan cursor while pressing the left mouse
button to pan.  Panning changes the location of the region displayed
but not the size of the area displayed or the resolution. Panning
does <em>not</em> affect the computational region for other GIS
processes, see <em><a href="g.region.html">g.region</a></em>.</dd>

<dt><img src="icons/grass2/zoom-in.png">&nbsp;
  <img src="icons/grass/gui-zoom_in.gif">&nbsp;
  <img src="icons/silk/zoom_in.png"> <em>Zoom in</em></dt>
<dd>Interactive zooming with the mouse in the active display monitor.
Drawing a box or just click with the mouse (left button) and zoom-in
cursor causes the display to zoom in so that the area defined by the
box fills the display. The map resolution is not changed. Clicking
with the zoom-in cursor causes the display to zoom in by 30%, centered
on the point where the mouse is clicked. Zooming resets the display
region extents (both size and location of area displayed). It
does <em>not</em> affect the computational region for other GIS
processes, see <em><a href="g.region.html">g.region</a></em>.</dd>

<dt><img src="icons/grass2/zoom-out.png">&nbsp;
  <img src="icons/grass/gui-zoom_out.gif">&nbsp;
  <img src="icons/silk/zoom_out.png"> <em>Zoom out</em></dt>
<dd>Interactive zooming with the mouse in the active display monitor.
Drawing a box or just click with the mouse (left button) and zoom-out
cursor causes the display to zoom in so that the area displayed
shrinks to fill the area defined by the box. The map resolution is not
changed. Clicking with the zoom-out cursor causes the display to zoom
out by 30%, centered on the point where the mouse is clicked. Zooming
resets the display region extents (both size and location of area
displayed). It does <em>not</em> affect the computational region for
other GIS processes,
see <em><a href="g.region.html">g.region</a></em>.</dd>

<dt><img src="icons/grass2/zoom-last.png">&nbsp;
  <img src="icons/grass/gui-zoom_back.gif">&nbsp;
  <img src="icons/silk/zoom_back.png"> <em>Revert zoom</em></dt>
<dd>Returns to the previous zoom. Up to 10 levels of zoom back are
maintained, see <em><a href="g.region.html">g.region</a></em>.</dd>

<dt><img src="icons/grass2/zoom-more.png">&nbsp;
  <img src="icons/grass/gui-mapzoom.gif">&nbsp;
  <img src="icons/silk/zoom.png"> <em>Zoom menu</em></dt>
<dd>Automatic zoom settings menu. Zoom to match the extents of a selected
map, zoom to match the computational region (set with
<em>g.region</em>), zoom to match the extents of a saved region or
save the current extents to a named region file, or to set
computational region (the mapset's <tt>WIND</tt> file) to match the
current display extents (does not change the resolution).
See <em><a href="g.region.html">g.region</a></em>.</dd>

<dt><img src="icons/grass2/layer-raster-analyze.png">&nbsp;
  <img src="icons/grass/gui-rastanalyze.gif">&nbsp;
  <img src="icons/silk/application_lightning.png"> <em>Analyze menu</em></dt>
<dd>Contains functions for distance measurement, creating histogram or
profile tool.</dd>

<dt><img src="icons/grass2/measure-length.png">&nbsp;
  <img src="icons/grass/gui-measure.gif">&nbsp;
  <img src="icons/silk/sum.png"> <em>Distance measurement tool</em></dt>
<dd>Interactive measurement of lengths defined with the mouse. The
length of each segment and the cumulative length of all segments
measuered is displayed in the command output window frame. Lengths are
measured in the current measurement unit,
see <em><a href="d.measure.html">d.measure</a></em>.</dd>

<dt><img src="icons/grass2/layer-raster-profile.png">&nbsp;
  <img src="icons/grass/gui-profile.gif">&nbsp;
  <img src="icons/silk/wand.png"> <em>Profile tool</em></dt>
<dd>Interactively create profile of a raster map. Profile transect is
drawn with the mouse in map display. The profile may be of the
displayed map or a different map,
see <em><a href="gm_profile.html">Profile Tool help
page</a></em>.</dd>

<dt><img src="icons/grass2/layer-raster-histogram.png">&nbsp;
  <img src="icons/silk/chart_bar.png">&nbsp;
  <img src="icons/grass/module-d.histogram.gif"> Display histogram of selected raster map</dt>
<dd>Displays histogram of selected raster map or image in new window,
see <em><a href="d.histogram.html">d.histogram</a></em>.</dd>

<dt><img src="icons/grass2/element-add.png">&nbsp;
  <img src="icons/silk/overlays.png">&nbsp;
  <img src="icons/grass/gui-rastanalyze.gif"> Add overlay</dt>
<dd>Adds overlay to map display like barscale, north arrow, text.</dd>

<dt><img src="icons/grass2/scalebar-add.png">&nbsp;
  <img src="icons/grass/module-d.barscale.gif">&nbsp;
  <img src="icons/silk/page_white_picture.png"> <em>Add scalebar and north arrow</em></dt>
<dd>Adds layer to display a combined scalebar and north arrow. Options
include scalebar placement (using screen coordinates or a mouse),
scalebar format, and scalebar colors,
see <em><a href="d.barscale.html">d.barscale</a></em>.</dd>

<dt><img src="icons/grass2/legend-add.png">&nbsp;
  <img src="icons/grass/module-d.legend.gif">&nbsp;
  <img src="icons/silk/page_green.png"> <em>Add raster map legend</em></dt>
<dd>Adds layer to display with legend of selected raster map,
see <em><a href="d.legend.html">d.legend</a></em>.</dd>

<dt><img src="icons/grass2/text-add.png">&nbsp;
  <img src="icons/grass/module-d.text.gif">&nbsp;
  <img src="icons/silk/textfield_add.png"> <em>Add text layer</em></dt>
<dd>Adds layer to display a line of text using default GRASS font
(selected with <em><a href="d.font.html">d.font</a></em>).  Options
include: text placement (screen coordinates); and text size, bolding,
and color, see <em><a href="d.text.html">d.text</a></em>.</dd>

<dt><img src="icons/grass2/map-export.png">&nbsp;
  <img src="icons/grass/file-save.gif">&nbsp;
  <img src="icons/silk/picture_save.png"> <em>Export map display</em></dt>
<dd>Exports visible map display to different raster graphic formats.</dd>

<dt><img src="icons/grass2/print.png">&nbsp;
  <img src="icons/grass/file-print.gif">&nbsp;
  <img src="icons/silk/printer.png"> <em>Print map</em></dt>
<dd>Prints map on the UNIX <i>lpr</i> printer or PostScript device;
saves visible map display (including PostScript text and labels) to PDF
or EPS file. Requires <tt>ghostscript</tt> for all output except EPS.</dd>

</dl>

<h2>CONFIGURATION</h2>

User preferences dialog ('Config->Preferences') enables configuration
of various options.

<h3>Icon Theme</h3>

Currently are supported three icon theme sets:

<ul>
  <li><em>new</em> <a href="http://www.szczepanek.pl/icons.grass/v.0.1/">GRASS theme</a> v0.1 (<tt>grass2</tt>)</li>
  <li><em>original TCL/TK-based</em> GRASS theme (<tt>grass</tt>)</li>
  <li><em>Silk theme</em>-based
  on <a href="http://www.famfamfam.com/lab/icons/silk/">Silk icon
  set</a>, v1.3 (<tt>silk</tt>)</li>
</ul>

<h2>SEE ALSO</h2>

<em>
<a href="wxGUI.Vector_Digitizing_Tool.html">Vector digitizing tool</a>,
<a href="wxGUI.Attribute_Table_Manager.html">Attribute Table Manager</a>,
<a href="wxGUI.Nviz.html">Nviz extension</a>
</em>

<p>
See also <a href="http://grass.osgeo.org/wiki/WxPython-based_GUI_for_GRASS">Wiki</a> page.

<h2>AUTHORS</h2>

(Alphabetically ordered)<br><br>

Michael Barton,<br>
Daniel Calvelo Aros,<br>
Jachym Cepicky,<br>
Martin Landa, FBK-irst, Trento, Italy

<p>
<i>$Date$</i>