GRASS Programmer's Manual
6.4.2(2012)
|
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 |
def gui_modules.render.Map.__init__ | ( | self, | |
gisrc = None |
|||
) |
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.
type | layer type ('raster', 'vector', etc.) |
command | GRASS command given as list |
name | layer name |
l_active | layer render only if True |
l_hidden | layer not displayed in layer tree if True |
l_opacity | opacity level range from 0(transparent) - 1(not transparent) |
l_render | render an image if True |
pos | position in layer list (-1 for append) |
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.
id | overlay id (PseudoDC) |
type | overlay type (barscale, legend) |
command | GRASS command to render overlay |
l_active | overlay activated (True) or disabled (False) |
l_hidden | overlay is not shown in layer tree (if True) |
l_render | render an image (if True) |
Definition at line 1157 of file render.py.
References gui_modules.mapdisp_window.BufferedWindow.overlays, and gui_modules.render.Map.overlays.
def gui_modules.render.Map.AdjustRegion | ( | self | ) |
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().
def gui_modules.render.Map.AlignExtentFromDisplay | ( | self | ) |
Align region extent based on display size from center point.
Definition at line 537 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.projinfo, gui_modules.render.Map.region, gui_modules.colorrules.ColorTable.width, gui_modules.render.Map.width, gui_modules.gdialogs.ImageSizeDialog.width, and gui_modules.gmodeler.ModelCondition.width.
def gui_modules.render.Map.AlignResolution | ( | self | ) |
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.
layer | map layer instance |
type | layer type ('raster', 'vector', etc.) |
command | GRASS command given as list |
name | layer name |
active | layer render only if True |
hidden | layer not displayed in layer tree if True |
opacity | opacity level range from 0(transparent) - 1(not transparent) |
render | render an image if True |
def gui_modules.render.Map.ChangeLayerActive | ( | self, | |
layer, | |||
active | |||
) |
def gui_modules.render.Map.ChangeLayerName | ( | self, | |
layer, | |||
name | |||
) |
def gui_modules.render.Map.ChangeMapSize | ( | self, | |
width, | |||
height | |||
) |
Change size of rendered map.
width,height | map size |
Definition at line 564 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.colorrules.ColorTable.width, gui_modules.render.Map.width, gui_modules.gdialogs.ImageSizeDialog.width, and gui_modules.gmodeler.ModelCondition.width.
def gui_modules.render.Map.ChangeOpacity | ( | self, | |
layer, | |||
l_opacity | |||
) |
def gui_modules.render.Map.ChangeOverlay | ( | self, | |
id, | |||
render = False , |
|||
kargs | |||
) |
Change overlay properities.
Add new overlay if overlay with 'id' doesn't exist.
id | overlay id (PseudoDC) |
type | overlay type (barscale, legend) |
command | GRASS command to render overlay |
l_active | overlay activated (True) or disabled (False) |
l_hidden | overlay is not shown in layer tree (if True) |
l_render | render an image (if True) |
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.Clean | ( | self | ) |
Clean layer stack - go trough all layers and remove them from layer list.
Removes also l_mapfile and l_maskfile
Definition at line 1257 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.histogram.BufferedWindow.mapfile, gui_modules.render.Layer.mapfile, gui_modules.mapdisp_window.BufferedWindow.mapfile, gui_modules.render.Map.mapfile, gui_modules.colorrules.BufferedWindow.mapfile, gui_modules.mapdisp_window.BufferedWindow.overlays, gui_modules.render.Map.overlays, and gui_modules::utils.split().
def gui_modules.render.Map.DeleteLayer | ( | self, | |
layer, | |||
overlay = False |
|||
) |
Removes layer from list of layers.
layer | layer instance in layer tree |
overlay | delete overlay (use self.DeleteOverlay() instead) |
Definition at line 993 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, and gui_modules.render.Map.overlays.
Referenced by gui_modules.render.Map.DeleteOverlay().
def gui_modules.render.Map.DeleteOverlay | ( | self, | |
overlay | |||
) |
Delete overlay.
id | overlay id |
Definition at line 1248 of file render.py.
References gui_modules.render.Map.DeleteLayer().
def gui_modules.render.Map.GetCurrentRegion | ( | self | ) |
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.
layer | layer instace in layer tree |
overlay | use list of overlays instead |
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.
l_type | layer type, e.g. raster/vector/wms/overlay (value or tuple of values) |
l_mapset | all layers from given mapset (only for maplayers) |
l_name | all layers with given name |
l_active | only layers with 'active' attribute set to True or False |
l_hidden | only layers with 'hidden' attribute set to True or False |
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'.
id | overlay id |
list | return list of overlays of True otherwise suppose 'id' to be unique |
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.GetProjInfo | ( | self | ) |
Get projection info.
Definition at line 432 of file render.py.
References gui_modules.render.Map._runCommand(), gui_modules::render.map, and gui_modules.render.Map.projinfo.
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.
rast | list of raster maps |
zoom | zoom to raster map (ignore NULLs) |
vect | list of vector maps |
regionName | named region or None |
n,s,e,w | force extent |
default | force default region settings |
update | if True update current display region settings |
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.GetWindow | ( | self | ) |
Read WIND file and set up self.wind dictionary.
Definition at line 463 of file render.py.
References gui_modules.render.Map.env, gui_modules.render.Map.wind, and gui_modules.gdialogs.SavedRegion.wind.
Referenced by gui_modules.psmap_dialogs.TCValidator.Validate(), and gui_modules.menuform.FloatValidator.Validate().
def gui_modules.render.Map.RemoveLayer | ( | self, | |
name = None , |
|||
id = None |
|||
) |
Removes layer from layer list.
Layer is defined by name or id.
name | layer name (must be unique) |
id | layer index in layer list |
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.
def gui_modules.render.Map.Render | ( | self, | |
force = False , |
|||
mapWindow = None , |
|||
windres = False |
|||
) |
Creates final image composite.
This function can conditionaly use high-level tools, which should be avaliable in wxPython library
force | force rendering |
reference | for MapFrame instance (for progress bar) |
windres | use region resolution (True) otherwise display resolution |
Definition at line 851 of file render.py.
References gui_modules.render.Map._renderLayers(), gui_modules.render.Map.gisrc, 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, gui_modules.histogram.BufferedWindow.mapfile, gui_modules.render.Layer.mapfile, gui_modules.mapdisp_window.BufferedWindow.mapfile, gui_modules.render.Map.mapfile, gui_modules.colorrules.BufferedWindow.mapfile, gui_modules.psmap_dialogs.Instruction.SetRegion(), gui_modules.render.Map.SetRegion(), gui_modules.colorrules.ColorTable.width, gui_modules.render.Map.width, gui_modules.gdialogs.ImageSizeDialog.width, and gui_modules.gmodeler.ModelCondition.width.
def gui_modules.render.Map.ReorderLayers | ( | self, | |
layerList | |||
) |
Reorder list to match layer tree.
layerList | list of layers |
Definition at line 1024 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.ReverseListOfLayers | ( | self | ) |
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.
windres | uses resolution from WIND file rather than display (for modules that require set resolution like d.rast.num) |
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().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map.GetWindow().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map.GetRegion(), and gui_modules.render.Map.Render().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map.Clean(), gui_modules.render.Map.DeleteLayer(), gui_modules.render.Map.GetLayerIndex(), gui_modules.render.Map.GetListOfLayers(), gui_modules.toolbars.VDigitToolbar.OnSelectMap(), gui_modules.workspace.ProcessGrcFile.process_line(), gui_modules.workspace.ProcessGrcFile.read(), gui_modules.render.Map.RemoveLayer(), gui_modules.render.Map.ReorderLayers(), and gui_modules.dbm_base.VectorDBInfo.SelectFromTable().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map.Clean(), and gui_modules.render.Map.Render().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map.AddOverlay(), gui_modules.render.Map.Clean(), gui_modules.render.Map.DeleteLayer(), gui_modules.render.Map.GetListOfLayers(), and gui_modules.render.Map.GetOverlay().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map.AlignExtentFromDisplay(), and gui_modules.render.Map.GetProjInfo().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map.AdjustRegion(), gui_modules.render.Map.AlignExtentFromDisplay(), gui_modules.render.Map.AlignResolution(), gui_modules.wxvdriver.DisplayDriver.DrawMap(), gui_modules.render.Map.GetCurrentRegion(), gui_modules.render.Map.GetRegion(), gui_modules.wxvdriver.DisplayDriver.GetThreshold(), gui_modules.render.Map.SetRegion(), and gui_modules.wxvdriver.DisplayDriver.UpdateRegion().
Definition at line 376 of file render.py.
Referenced by gui_modules.render.Map::GetWindow(), and gui_modules.render.Map::SetRegion().