GRASS Programmer's Manual  6.4.2(2012)
gui_modules.render.Map Class Reference

Map composition (stack of map layers and overlays) More...

Public Member Functions

def __init__
def GetProjInfo
 Get projection info.
def GetWindow
 Read WIND file and set up self.wind dictionary.
def AdjustRegion
 Adjusts display resolution to match monitor size in pixels.
def AlignResolution
 Sets display extents to even multiple of current resolution defined in WIND file from SW corner.
def AlignExtentFromDisplay
 Align region extent based on display size from center point.
def ChangeMapSize
 Change size of rendered map.
def GetRegion
 Get region settings (g.region -upgc)
def GetCurrentRegion
 Get current display region settings.
def SetRegion
 Render string for GRASS_REGION env.
def GetListOfLayers
 Returns list of layers of selected properties or list of all layers.
def Render
 Creates final image composite.
def AddLayer
 Adds generic map layer to list of layers.
def DeleteLayer
 Removes layer from list of layers.
def ReorderLayers
 Reorder list to match layer tree.
def ChangeLayer
 Change map layer properties.
def ChangeOpacity
 Changes opacity value of map layer.
def ChangeLayerActive
 Enable or disable map layer.
def ChangeLayerName
 Change name of the layer.
def RemoveLayer
 Removes layer from layer list.
def GetLayerIndex
 Get index of layer in layer list.
def AddOverlay
 Adds overlay (grid, barscale, legend, etc.) to list of overlays.
def ChangeOverlay
 Change overlay properities.
def GetOverlay
 Return overlay(s) with 'id'.
def DeleteOverlay
 Delete overlay.
def Clean
 Clean layer stack - go trough all layers and remove them from layer list.
def ReverseListOfLayers
 Reverse list of layers.

Data Fields

 wind
 region
 width
 height
 layers
 overlays
 ovlookup
 env
 gisrc
 mapfile
 projinfo

Detailed Description

Map composition (stack of map layers and overlays)

Definition at line 373 of file render.py.


Constructor & Destructor Documentation

def gui_modules.render.Map.__init__ (   self,
  gisrc = None 
)

Definition at line 376 of file render.py.


Member Function Documentation

def gui_modules.render.Map.AddLayer (   self,
  type,
  command,
  name = None,
  l_active = True,
  l_hidden = False,
  l_opacity = 1.0,
  l_render = False,
  pos = -1 
)

Adds generic map layer to list of layers.

Parameters:
typelayer type ('raster', 'vector', etc.)
commandGRASS command given as list
namelayer name
l_activelayer render only if True
l_hiddenlayer not displayed in layer tree if True
l_opacityopacity level range from 0(transparent) - 1(not transparent)
l_renderrender an image if True
posposition in layer list (-1 for append)
Returns:
new layer on success
None on failure

Definition at line 954 of file render.py.

def gui_modules.render.Map.AddOverlay (   self,
  id,
  type,
  command,
  l_active = True,
  l_hidden = True,
  l_opacity = 1.0,
  l_render = False 
)

Adds overlay (grid, barscale, legend, etc.) to list of overlays.

Parameters:
idoverlay id (PseudoDC)
typeoverlay type (barscale, legend)
commandGRASS command to render overlay
l_activeoverlay activated (True) or disabled (False)
l_hiddenoverlay is not shown in layer tree (if True)
l_renderrender an image (if True)
Returns:
new layer on success None on failure

Definition at line 1157 of file render.py.

References gui_modules.mapdisp_window.BufferedWindow.overlays, and gui_modules.render.Map.overlays.

Adjusts display resolution to match monitor size in pixels.

Maintains constant display resolution, not related to computational region. Do NOT use the display resolution to set computational resolution. Set computational resolution through g.region.

Definition at line 485 of file render.py.

References gui_modules.histogram.HistFrame.height, gui_modules.colorrules.ColorTable.height, gui_modules.render.Map.height, gui_modules.gcpmapdisp.MapFrame.height, gui_modules.mapdisp.MapFrame.height, gui_modules.gdialogs.ImageSizeDialog.height, gui_modules.gmodeler.ModelCondition.height, gui_modules.render.Map.region, round, gui_modules.colorrules.ColorTable.width, gui_modules.render.Map.width, gui_modules.gdialogs.ImageSizeDialog.width, and gui_modules.gmodeler.ModelCondition.width.

Referenced by gui_modules.render.Map.SetRegion().

Sets display extents to even multiple of current resolution defined in WIND file from SW corner.

This must be done manually as using the -a flag can produce incorrect extents.

Definition at line 505 of file render.py.

References gui_modules.render.Map.GetRegion(), gui_modules.render.Map.region, and round.

def gui_modules.render.Map.ChangeLayer (   self,
  layer,
  render = False,
  kargs 
)

Change map layer properties.

Parameters:
layermap layer instance
typelayer type ('raster', 'vector', etc.)
commandGRASS command given as list
namelayer name
activelayer render only if True
hiddenlayer not displayed in layer tree if True
opacityopacity level range from 0(transparent) - 1(not transparent)
renderrender an image if True

Definition at line 1038 of file render.py.

def gui_modules.render.Map.ChangeLayerActive (   self,
  layer,
  active 
)

Enable or disable map layer.

Parameters:
layerlayer instance in layer tree
activeto be rendered (True)

Definition at line 1090 of file render.py.

def gui_modules.render.Map.ChangeLayerName (   self,
  layer,
  name 
)

Change name of the layer.

Parameters:
layerlayer instance in layer tree
namelayer name to set up

Definition at line 1101 of file render.py.

def gui_modules.render.Map.ChangeOpacity (   self,
  layer,
  l_opacity 
)

Changes opacity value of map layer.

Parameters:
layerlayer instance in layer tree
l_opacityopacity level <0;1>

Definition at line 1076 of file render.py.

def gui_modules.render.Map.ChangeOverlay (   self,
  id,
  render = False,
  kargs 
)

Change overlay properities.

Add new overlay if overlay with 'id' doesn't exist.

Parameters:
idoverlay id (PseudoDC)
typeoverlay type (barscale, legend)
commandGRASS command to render overlay
l_activeoverlay activated (True) or disabled (False)
l_hiddenoverlay is not shown in layer tree (if True)
l_renderrender an image (if True)
Returns:
new layer on success

Definition at line 1185 of file render.py.

References gui_modules.mapdisp_window.BufferedWindow.GetOverlay(), and gui_modules.render.Map.GetOverlay().

def gui_modules.render.Map.DeleteLayer (   self,
  layer,
  overlay = False 
)
def gui_modules.render.Map.DeleteOverlay (   self,
  overlay 
)

Delete overlay.

Parameters:
idoverlay id
Returns:
removed overlay on success or None

Definition at line 1248 of file render.py.

References gui_modules.render.Map.DeleteLayer().

Get current display region settings.

Definition at line 681 of file render.py.

References gui_modules.render.Map.region.

def gui_modules.render.Map.GetLayerIndex (   self,
  layer,
  overlay = False 
)

Get index of layer in layer list.

Parameters:
layerlayer instace in layer tree
overlayuse list of overlays instead
Returns:
layer index
-1 if layer not found

Definition at line 1138 of file render.py.

References gui_modules.nviz_mapdisp.GLWindow.layers, gui_modules.render.Map.layers, gui_modules.gselect.VectorDBInfo.layers, gui_modules.gdialogs.AddMapLayersDialog.layers, gui_modules.psmap_dialogs.VProperties.layers, gui_modules.dbm.LayerListCtrl.layers, and gui_modules.psmap_dialogs.VPropertiesDialog.layers.

def gui_modules.render.Map.GetListOfLayers (   self,
  l_type = None,
  l_mapset = None,
  l_name = None,
  l_active = None,
  l_hidden = None 
)

Returns list of layers of selected properties or list of all layers.

Parameters:
l_typelayer type, e.g. raster/vector/wms/overlay (value or tuple of values)
l_mapsetall layers from given mapset (only for maplayers)
l_nameall layers with given name
l_activeonly layers with 'active' attribute set to True or False
l_hiddenonly layers with 'hidden' attribute set to True or False
Returns:
list of selected layers

Definition at line 752 of file render.py.

References gui_modules.nviz_mapdisp.GLWindow.layers, gui_modules.render.Map.layers, gui_modules.gselect.VectorDBInfo.layers, gui_modules.gdialogs.AddMapLayersDialog.layers, gui_modules.psmap_dialogs.VProperties.layers, gui_modules.dbm.LayerListCtrl.layers, gui_modules.psmap_dialogs.VPropertiesDialog.layers, gui_modules.mapdisp_window.BufferedWindow.overlays, gui_modules.render.Map.overlays, and gui_modules::psmap_dialogs.type.

def gui_modules.render.Map.GetOverlay (   self,
  id,
  list = False 
)

Return overlay(s) with 'id'.

Parameters:
idoverlay id
listreturn list of overlays of True otherwise suppose 'id' to be unique
Returns:
list of overlays (list=True)
overlay (list=False) None (list=False) if no overlay or more overlays found

Definition at line 1224 of file render.py.

References gui_modules.mapdisp_window.BufferedWindow.overlays, and gui_modules.render.Map.overlays.

Referenced by gui_modules.render.Map.ChangeOverlay().

def gui_modules.render.Map.GetRegion (   self,
  rast = [],
  zoom = False,
  vect = [],
  regionName = None,
  n = None,
  s = None,
  e = None,
  w = None,
  default = False,
  update = False 
)

Get region settings (g.region -upgc)

Optionally extent, raster or vector map layer can be given.

Parameters:
rastlist of raster maps
zoomzoom to raster map (ignore NULLs)
vectlist of vector maps
regionNamenamed region or None
n,s,e,wforce extent
defaultforce default region settings
updateif True update current display region settings
Returns:
region settings as directory, e.g. { 'n':'4928010', 's':'4913700', 'w':'589980',...}

Definition at line 583 of file render.py.

References gui_modules.render.Map.gisrc, and gui_modules.render.Map.region.

Referenced by gui_modules.render.Map.AlignResolution(), and gui_modules.render.Map.SetRegion().

def gui_modules.render.Map.RemoveLayer (   self,
  name = None,
  id = None 
)

Removes layer from layer list.

Layer is defined by name or id.

Parameters:
namelayer name (must be unique)
idlayer index in layer list
Returns:
removed layer on success
None on failure

Definition at line 1111 of file render.py.

References gui_modules.nviz_mapdisp.GLWindow.layers, gui_modules.render.Map.layers, gui_modules.gselect.VectorDBInfo.layers, gui_modules.gdialogs.AddMapLayersDialog.layers, gui_modules.psmap_dialogs.VProperties.layers, gui_modules.dbm.LayerListCtrl.layers, and gui_modules.psmap_dialogs.VPropertiesDialog.layers.

Reverse list of layers.

Definition at line 1294 of file render.py.

def gui_modules.render.Map.SetRegion (   self,
  windres = False 
)

Render string for GRASS_REGION env.

variable, so that the images will be rendered from desired zoom level.

Parameters:
windresuses resolution from WIND file rather than display (for modules that require set resolution like d.rast.num)
Returns:
String usable for GRASS_REGION variable or None

Definition at line 685 of file render.py.

References gui_modules.render.Map.AdjustRegion(), gui_modules.render.Map.GetRegion(), gui_modules.render.Map.region, gui_modules.render.Map.wind, and gui_modules.gdialogs.SavedRegion.wind.

Referenced by gui_modules.render.Map.Render().


Field Documentation

Definition at line 376 of file render.py.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines