render.py 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312
  1. """
  2. @package render
  3. Rendering map layers and overlays into map composition image
  4. Classes:
  5. - Layer
  6. - MapLayer
  7. - Overlay
  8. - Map
  9. C) 2006-2008 by the GRASS Development Team
  10. This program is free software under the GNU General Public
  11. License (>=v2). Read the file COPYING that comes with GRASS
  12. for details.
  13. @author Michael Barton, Jachym Cepicky,
  14. Martin Landa <landa.martin gmail.com>
  15. @date 2006-2008
  16. """
  17. import os
  18. import sys
  19. import glob
  20. import math
  21. import copy
  22. try:
  23. import subprocess
  24. except:
  25. compatPath = os.path.join(globalvar.ETCWXDIR, "compat")
  26. sys.path.append(compatPath)
  27. import subprocess
  28. import tempfile
  29. import wx
  30. from wx.lib.newevent import NewEvent
  31. import globalvar
  32. import utils
  33. import gcmd
  34. from debug import Debug as Debug
  35. from preferences import globalSettings as UserSettings
  36. wxUpdateProgressBar, EVT_UPDATE_PRGBAR = NewEvent()
  37. #
  38. # use g.pnmcomp for creating image composition or
  39. # wxPython functionality
  40. #
  41. USE_GPNMCOMP = True
  42. class Layer(object):
  43. """Virtual class which stores information about layers (map layers and
  44. overlays) of the map composition.
  45. For map layer use MapLayer class.
  46. For overlays use Overlay class.
  47. """
  48. def __init__(self, type, cmd, name=None,
  49. active=True, hidden=False, opacity=1.0):
  50. """
  51. @param type layer type ('raster', 'vector', 'overlay', 'command', etc.)
  52. @param cmd GRASS command to render layer,
  53. given as list, e.g. ['d.rast', 'map=elevation@PERMANENT']
  54. @param name layer name, e.g. 'elevation@PERMANENT' (for layer tree)
  55. @param active layer is active, will be rendered only if True
  56. @param hidden layer is hidden, won't be listed in Layer Manager if True
  57. @param opacity layer opacity <0;1>
  58. """
  59. self.type = type
  60. self.name = name
  61. self.cmdlist = cmd
  62. self.active = active
  63. self.hidden = hidden
  64. self.opacity = opacity
  65. self.force_render = True
  66. Debug.msg (3, "Layer.__init__(): type=%s, cmd='%s', name=%s, " \
  67. "active=%d, opacity=%d, hidden=%d" % \
  68. (self.type, self.GetCmd(string=True), self.name, self.active,
  69. self.opacity, self.hidden))
  70. # generated file for each layer
  71. self.gtemp = tempfile.mkstemp()[1]
  72. self.maskfile = self.gtemp + ".pgm"
  73. if self.type == 'overlay':
  74. self.mapfile = self.gtemp + ".png"
  75. else:
  76. self.mapfile = self.gtemp + ".ppm"
  77. def __del__(self):
  78. Debug.msg (3, "Layer.__del__(): layer=%s, cmd='%s'" %
  79. (self.name, self.GetCmd(string=True)))
  80. def Render(self):
  81. """Render layer to image
  82. @return rendered image filename
  83. @return None on error
  84. """
  85. if len(self.cmdlist) == 0:
  86. return None
  87. # ignore in 2D
  88. if self.type == '3d-raster':
  89. return None
  90. Debug.msg (3, "Layer.Render(): type=%s, name=%s" % \
  91. (self.type, self.name))
  92. #
  93. # prepare command for each layer
  94. #
  95. layertypes = ['raster', 'rgb', 'his', 'shaded', 'rastarrow', 'rastnum',
  96. 'vector','thememap','themechart',
  97. 'grid', 'geodesic', 'rhumb', 'labels',
  98. 'command',
  99. 'overlay']
  100. if self.type not in layertypes:
  101. raise gcmd.GStdError(_("<%(name)s>: layer type <%(type)s> is not supported yet.") % \
  102. {'type' : self.type, 'name' : self.name})
  103. #
  104. # start monitor
  105. #
  106. if self.mapfile:
  107. os.environ["GRASS_PNGFILE"] = self.mapfile
  108. #
  109. # execute command
  110. #
  111. try:
  112. if self.type == 'command':
  113. read = False
  114. for cmd in self.cmdlist:
  115. runcmd = gcmd.Command(cmd=cmd + ['--q'],
  116. stderr=None)
  117. if runcmd.returncode != 0:
  118. break
  119. if not read:
  120. os.environ["GRASS_PNG_READ"] = "TRUE"
  121. os.environ["GRASS_PNG_READ"] = "FALSE"
  122. else:
  123. runcmd = gcmd.Command(cmd=self.cmdlist + ['--q'],
  124. stderr=None)
  125. if runcmd.returncode != 0:
  126. #clean up after probley
  127. try:
  128. os.remove(self.mapfile)
  129. os.remove(self.maskfile)
  130. os.remove(self.gtemp)
  131. except (OSError, TypeError):
  132. pass
  133. self.mapfile = None
  134. self.maskfile = None
  135. except gcmd.CmdError, e:
  136. print >> sys.stderr, e
  137. # clean up after problems
  138. try:
  139. os.remove(self.mapfile)
  140. os.remove(self.maskfile)
  141. os.remove(self.gtemp)
  142. except (OSError, TypeError):
  143. pass
  144. self.mapfile = None
  145. self.maskfile = None
  146. #
  147. # stop monitor
  148. #
  149. if os.environ.has_key("GRASS_PNGFILE"):
  150. del os.environ["GRASS_PNGFILE"]
  151. self.force_render = False
  152. return self.mapfile
  153. def GetCmd(self, string=False):
  154. """
  155. Get GRASS command as list of string.
  156. @param string get command as string if True otherwise as list
  157. @return command list/string
  158. """
  159. if string:
  160. if self.type == 'command':
  161. cmdStr = ''
  162. for cmd in self.cmdlist:
  163. cmdStr += ' '.join(cmd) + ';'
  164. return cmdStr.rstrip(';')
  165. else:
  166. return ' '.join(self.cmdlist)
  167. else:
  168. return self.cmdlist
  169. def GetType(self):
  170. """Get map layer type"""
  171. return self.type
  172. def GetOpacity(self, float=False):
  173. """
  174. Get layer opacity level
  175. @param float get opacity level in <0,1> otherwise <0,100>
  176. @return opacity level
  177. """
  178. if float:
  179. return self.opacity
  180. return int (self.opacity * 100)
  181. def GetName(self, fullyQualified=True):
  182. """Get map layer name
  183. @param fullyQualified if True return 'name@mapset' otherwise
  184. ('name', 'mapset')
  185. """
  186. if fullyQualified:
  187. return self.name
  188. else:
  189. if '@' in self.name:
  190. return { 'name' : self.name.split('@')[0],
  191. 'mapset' : self.name.split('@')[1] }
  192. else:
  193. return { 'name' : self.name,
  194. 'mapset' : '' }
  195. def IsActive(self):
  196. """Check if layer is activated for rendering"""
  197. return self.active
  198. def SetType(self, type):
  199. """Set layer type"""
  200. if type not in ('raster', '3d-raster', 'vector',
  201. 'overlay', 'command',
  202. 'shaded', 'rgb', 'his', 'rastarrow', 'rastnum',
  203. 'thememap', 'themechart', 'grid', 'labels',
  204. 'geodesic','rhumb'):
  205. raise gcmd.GStdError(_("Unsupported map layer type '%s'") % str(type))
  206. self.type = type
  207. def SetName(self, name):
  208. """Set layer name"""
  209. self.name = name
  210. def SetCmd(self, cmd):
  211. """Set layer name"""
  212. self.cmdlist = cmd
  213. def SetActive(self, enable=True):
  214. """Active or deactive layer"""
  215. self.active = bool(enable)
  216. def SetHidden(self, enable=False):
  217. """Hide or show map layer in Layer Manager"""
  218. self.hidden = bool(enable)
  219. def SetOpacity(self, value):
  220. """Set opacity value"""
  221. if value < 0:
  222. value = 0.
  223. elif value > 1:
  224. value = 1.
  225. self.opacity = float(value)
  226. def SetCmd(self, cmd):
  227. """Set new command for layer"""
  228. self.cmdlist = cmd
  229. Debug.msg(3, "Layer.SetCmd(): cmd='%s'" % self.GetCmd(string=True))
  230. # for re-rendering
  231. self.force_render = True
  232. class MapLayer(Layer):
  233. """Represents map layer in the map canvas"""
  234. def __init__(self, type, cmd, name=None,
  235. active=True, hidden=False, opacity=1.0):
  236. """
  237. @param type layer type ('raster', 'vector', 'command', etc.)
  238. @param cmd GRASS command to render layer,
  239. given as list, e.g. ['d.rast', 'map=elevation@PERMANENT']
  240. @param name layer name, e.g. 'elevation@PERMANENT' (for layer tree) or None
  241. @param active layer is active, will be rendered only if True
  242. @param hidden layer is hidden, won't be listed in Layer Manager if True
  243. @param opacity layer opacity <0;1>
  244. """
  245. Layer.__init__(self, type, cmd, name,
  246. active, hidden, opacity)
  247. #self.mapfile = self.gtemp + ".ppm"
  248. def GetMapset(self):
  249. """
  250. Get mapset of map layer
  251. @return mapset name
  252. @return '' on error (no name given)
  253. """
  254. if not self.name:
  255. return ''
  256. try:
  257. return self.name.split('@')[1]
  258. except IndexError:
  259. return self.name
  260. class Overlay(Layer):
  261. """Represents overlay displayed in map canvas"""
  262. def __init__(self, id, type, cmd,
  263. active=True, hidden=True, opacity=1.0):
  264. """
  265. @param id overlay id (for PseudoDC)
  266. @param type overlay type ('barscale', 'legend', etc.)
  267. @param cmd GRASS command to render overlay,
  268. given as list, e.g. ['d.legend', 'map=elevation@PERMANENT']
  269. @param active layer is active, will be rendered only if True
  270. @param hidden layer is hidden, won't be listed in Layer Manager if True
  271. @param opacity layer opacity <0;1>
  272. """
  273. Layer.__init__(self, 'overlay', cmd, type,
  274. active, hidden, opacity)
  275. self.id = id
  276. #self.mapfile = self.gtemp + ".png"
  277. class Map(object):
  278. """
  279. Map composition (stack of map layers and overlays)
  280. """
  281. def __init__(self, gisrc=None):
  282. #
  283. # region/extent settigns
  284. #
  285. self.wind = {} # WIND settings (wind file)
  286. self.region = {} # region settings (g.region)
  287. self.width = 640 # map width
  288. self.height = 480 # map height
  289. #
  290. # list of layers
  291. #
  292. self.layers = [] # stack of available GRASS layer
  293. self.overlays = [] # stack of available overlays
  294. self.ovlookup = {} # lookup dictionary for overlay items and overlays
  295. #
  296. # environment settings
  297. #
  298. # environment variables, like MAPSET, LOCATION_NAME, etc.
  299. self.env = {}
  300. # path to external gisrc
  301. self.gisrc = gisrc
  302. #
  303. # generated file for g.pnmcomp output for rendering the map
  304. #
  305. #self.mapfile = utils.GetTempfile()
  306. self.mapfile = tempfile.mkstemp(suffix='.ppm')[1]
  307. # setting some initial env. variables
  308. self.InitGisEnv() # g.gisenv
  309. self.InitRegion()
  310. #
  311. # GRASS environment variable (for rendering)
  312. #
  313. os.environ["GRASS_TRANSPARENT"] = "TRUE"
  314. os.environ["GRASS_BACKGROUNDCOLOR"] = "ffffff"
  315. def InitRegion(self):
  316. """
  317. Initialize current region settings.
  318. Set up 'self.region' using g.region command and
  319. self.wind according to the wind file.
  320. Adjust self.region based on map window size.
  321. """
  322. #
  323. # setting region ('g.region -upg')
  324. #
  325. ### not needed here (MapFrame.OnSize())
  326. # self.region = self.GetRegion()
  327. #
  328. # read WIND file
  329. #
  330. self.GetWindow()
  331. #
  332. # setting resolution
  333. #
  334. # not needed here (MapFrame.OnSize())
  335. # self.SetRegion()
  336. def InitGisEnv(self):
  337. """
  338. Stores GRASS variables (g.gisenv) to self.env variable
  339. """
  340. if not os.getenv("GISBASE"):
  341. print >> sys.stderr, _("GISBASE not set. You must be in GRASS GIS to run this program.")
  342. sys.exit(1)
  343. # use external gisrc if defined
  344. gisrc_orig = os.getenv("GISRC")
  345. if self.gisrc:
  346. os.environ["GISRC"] = self.gisrc
  347. gisenvCmd = gcmd.Command(["g.gisenv"])
  348. for line in gisenvCmd.ReadStdOutput():
  349. line = line.strip()
  350. key, val = line.split("=")
  351. val = val.replace(";","")
  352. val = val.replace("'","")
  353. self.env[key] = val
  354. # back to original gisrc
  355. if self.gisrc:
  356. os.environ["GISRC"] = gisrc_orig
  357. def GetWindow(self):
  358. """Read WIND file and set up self.wind dictionary"""
  359. # FIXME: duplicated region WIND == g.region (at least some values)
  360. filename = os.path.join (self.env['GISDBASE'],
  361. self.env['LOCATION_NAME'],
  362. self.env['MAPSET'],
  363. "WIND")
  364. try:
  365. windfile = open (filename, "r")
  366. except IOError, e:
  367. sys.stderr.write("%s: %s <%s>: %s\n%s\n" % (_("Error"), _("Unable to open file"),
  368. filename, e,
  369. _("wxGUI closed.")))
  370. sys.exit(1)
  371. for line in windfile.readlines():
  372. line = line.strip()
  373. key, value = line.split(":",1)
  374. key = key.strip()
  375. value = value.strip()
  376. self.wind[key] = value
  377. windfile.close()
  378. return self.wind
  379. def AdjustRegion(self):
  380. """
  381. Adjusts display resolution to match monitor size in pixels.
  382. Maintains constant display resolution, not related to computational
  383. region. Do NOT use the display resolution to set computational
  384. resolution. Set computational resolution through g.region.
  385. """
  386. mapwidth = abs(self.region["e"] - self.region["w"])
  387. mapheight = abs(self.region['n'] - self.region['s'])
  388. self.region["nsres"] = mapheight / self.height
  389. self.region["ewres"] = mapwidth / self.width
  390. self.region['rows'] = round(mapheight / self.region["nsres"])
  391. self.region['cols'] = round(mapwidth / self.region["ewres"])
  392. self.region['cells'] = self.region['rows'] * self.region['cols']
  393. Debug.msg (3, "Map.AdjustRegion(): %s" % self.region)
  394. return self.region
  395. def AlignResolution(self):
  396. """
  397. Sets display extents to even multiple of
  398. current resolution defined in WIND file from SW corner.
  399. This must be done manually as using the -a flag
  400. can produce incorrect extents.
  401. """
  402. # new values to use for saving to region file
  403. new = {}
  404. n = s = e = w = 0.0
  405. nwres = ewres = 0.0
  406. # Get current values for region and display
  407. nsres = self.GetRegion()['nsres']
  408. ewres = self.GetRegion()['ewres']
  409. n = float(self.region['n'])
  410. s = float(self.region['s'])
  411. e = float(self.region['e'])
  412. w = float(self.region['w'])
  413. # Calculate rows, columns, and extents
  414. new['rows'] = math.fabs(round((n-s)/nsres))
  415. new['cols'] = math.fabs(round((e-w)/ewres))
  416. # Calculate new extents
  417. new['s'] = nsres * round(s/nsres)
  418. new['w'] = ewres * round(w/ewres)
  419. new['n'] = new['s'] + (new['rows'] * nsres)
  420. new['e'] = new['w'] + (new['cols'] * ewres)
  421. return new
  422. def AlignExtentFromDisplay(self):
  423. """Align region extent based on display size from center point"""
  424. # calculate new bounding box based on center of display
  425. if self.region["ewres"] > self.region["nsres"]:
  426. res = self.region["ewres"]
  427. else:
  428. res = self.region["nsres"]
  429. Debug.msg(3, "Map.AlignExtentFromDisplay(): width=%d, height=%d, res=%f, center=%f,%f" % \
  430. (self.width, self.height, res, self.region['center_easting'],
  431. self.region['center_northing']))
  432. ew = (self.width / 2) * res
  433. ns = (self.height / 2) * res
  434. self.region['n'] = self.region['center_northing'] + ns
  435. self.region['s'] = self.region['center_northing'] - ns
  436. self.region['e'] = self.region['center_easting'] + ew
  437. self.region['w'] = self.region['center_easting'] - ew
  438. def ChangeMapSize(self, (width, height)):
  439. """Change size of rendered map.
  440. @param width,height map size
  441. @return True on success
  442. @return False on failure
  443. """
  444. try:
  445. self.width = int(width)
  446. self.height = int(height)
  447. Debug.msg(2, "Map.ChangeMapSize(): width=%d, height=%d" % \
  448. (self.width, self.height))
  449. return True
  450. except:
  451. self.width = 640
  452. self.height = 480
  453. return False
  454. def GetRegion(self, rast=None, zoom=False, vect=None,
  455. n=None, s=None, e=None, w=None, default=False,
  456. update=False):
  457. """
  458. Get region settings (g.region -upgc)
  459. Optionally extent, raster or vector map layer can be given.
  460. @param rast raster name or None
  461. @param vect vector name or None
  462. @param zoom zoom to raster (ignore NULLs)
  463. @param n,s,e,w force extent
  464. @param default force default region settings
  465. @param update if True update current display region settings
  466. @return region settings as directory, e.g. {
  467. 'n':'4928010', 's':'4913700', 'w':'589980',...}
  468. """
  469. region = {}
  470. tmpreg = os.getenv("GRASS_REGION")
  471. if tmpreg:
  472. del os.environ["GRASS_REGION"]
  473. # use external gisrc if defined
  474. gisrc_orig = os.getenv("GISRC")
  475. if self.gisrc:
  476. os.environ["GISRC"] = self.gisrc
  477. # do not update & shell style output
  478. cmdList = ["g.region", "-u", "-g", "-p", "-c"]
  479. if default:
  480. cmdList.append('-d')
  481. if n:
  482. cmdList.append('n=%s' % n)
  483. if s:
  484. cmdList.append('s=%s' % s)
  485. if e:
  486. cmdList.append('e=%s' % e)
  487. if w:
  488. cmdList.append('w=%s' % w)
  489. if rast:
  490. if zoom:
  491. cmdList.append('zoom=%s' % rast)
  492. else:
  493. cmdList.append('rast=%s' % rast)
  494. if vect:
  495. cmdList.append('vect=%s' % vect)
  496. try:
  497. cmdRegion = gcmd.Command(cmdList)
  498. except gcmd.CmdError, e:
  499. if rast:
  500. e.message = _("Unable to zoom to raster map <%s>.") % rast + \
  501. '%s%s' % (os.linesep, os.linesep) + e.message
  502. elif vect:
  503. e.message = _("Unable to zoom to vector map <%s>.") % vect + \
  504. '%s%s' % (os.linesep, os.linesep) + e.message
  505. print >> sys.stderr, e
  506. return self.region
  507. for reg in cmdRegion.ReadStdOutput():
  508. key, val = reg.split("=", 1)
  509. try:
  510. region[key] = float(val)
  511. except ValueError:
  512. region[key] = val
  513. # back to original gisrc
  514. if self.gisrc:
  515. os.environ["GISRC"] = gisrc_orig
  516. # restore region
  517. if tmpreg:
  518. os.environ["GRASS_REGION"] = tmpreg
  519. Debug.msg (3, "Map.GetRegion(): %s" % region)
  520. if update:
  521. self.region = region
  522. return region
  523. def GetCurrentRegion(self):
  524. """Get current display region settings"""
  525. return self.region
  526. def SetRegion(self, windres=False):
  527. """
  528. Render string for GRASS_REGION env. variable, so that the images will be rendered
  529. from desired zoom level.
  530. @param windres uses resolution from WIND file rather than display (for modules that require set
  531. resolution like d.rast.num)
  532. @return String usable for GRASS_REGION variable or None
  533. """
  534. grass_region = ""
  535. if windres:
  536. compRegion = self.GetRegion()
  537. region = copy.copy(self.region)
  538. for key in ('nsres', 'ewres',
  539. 'rows', 'cols', 'cells'):
  540. region[key] = compRegion[key]
  541. else:
  542. # adjust region settings to match monitor
  543. region = self.AdjustRegion()
  544. # read values from wind file
  545. try:
  546. for key in self.wind.keys():
  547. if key == 'north':
  548. grass_region += "north: %s; " % \
  549. (region['n'])
  550. continue
  551. elif key == "south":
  552. grass_region += "south: %s; " % \
  553. (region['s'])
  554. continue
  555. elif key == "east":
  556. grass_region += "east: %s; " % \
  557. (region['e'])
  558. continue
  559. elif key == "west":
  560. grass_region += "west: %s; " % \
  561. (region['w'])
  562. continue
  563. elif key == "e-w resol":
  564. grass_region += "e-w resol: %f; " % \
  565. (region['ewres'])
  566. continue
  567. elif key == "n-s resol":
  568. grass_region += "n-s resol: %f; " % \
  569. (region['nsres'])
  570. continue
  571. elif key == "cols":
  572. grass_region += 'cols: %d; ' % \
  573. region['cols']
  574. continue
  575. elif key == "rows":
  576. grass_region += 'rows: %d; ' % \
  577. region['rows']
  578. continue
  579. else:
  580. grass_region += key + ": " + self.wind[key] + "; "
  581. Debug.msg (3, "Map.SetRegion(): %s" % grass_region)
  582. return grass_region
  583. except:
  584. return None
  585. def ProjInfo(self):
  586. """
  587. Return region projection and map units information
  588. """
  589. projinfo = {}
  590. p = gcmd.Command(['g.proj', '-p'])
  591. if p.returncode == 0:
  592. for line in p.ReadStdOutput():
  593. if ':' in line:
  594. key,val = line.split(':')
  595. key = key.strip()
  596. val = val.strip()
  597. projinfo[key] = val
  598. elif "XY location (unprojected)" in line:
  599. projinfo['proj'] = "xy"
  600. projinfo['units'] = ''
  601. return projinfo
  602. else:
  603. return None
  604. def GetListOfLayers(self, l_type=None, l_mapset=None, l_name=None,
  605. l_active=None, l_hidden=None):
  606. """
  607. Returns list of layers of selected properties or list of all
  608. layers.
  609. @param l_type layer type, e.g. raster/vector/wms/overlay (value or tuple of values)
  610. @param l_mapset all layers from given mapset (only for maplayers)
  611. @param l_name all layers with given name
  612. @param l_active only layers with 'active' attribute set to True or False
  613. @param l_hidden only layers with 'hidden' attribute set to True or False
  614. @return list of selected layers
  615. """
  616. selected = []
  617. if type(l_type) == type(''):
  618. one_type = True
  619. else:
  620. one_type = False
  621. if one_type and l_type == 'overlay':
  622. list = self.overlays
  623. else:
  624. list = self.layers
  625. # ["raster", "vector", "wms", ... ]
  626. for layer in list:
  627. # specified type only
  628. if l_type != None:
  629. if one_type and layer.type != l_type:
  630. continue
  631. elif not one_type and layer.type not in l_type:
  632. continue
  633. # mapset
  634. if (l_mapset != None and type != 'overlay') and \
  635. layer.GetMapset() != l_mapset:
  636. continue
  637. # name
  638. if l_name != None and layer.name != l_name:
  639. continue
  640. # hidden and active layers
  641. if l_active != None and \
  642. l_hidden != None:
  643. if layer.active == l_active and \
  644. layer.hidden == l_hidden:
  645. selected.append(layer)
  646. # active layers
  647. elif l_active != None:
  648. if layer.active == l_active:
  649. selected.append(layer)
  650. # hidden layers
  651. elif l_hidden != None:
  652. if layer.hidden == l_hidden:
  653. selected.append(layer)
  654. # all layers
  655. else:
  656. selected.append(layer)
  657. Debug.msg (3, "Map.GetListOfLayers(): numberof=%d" % len(selected))
  658. return selected
  659. def _renderLayers(self, force, mapWindow, maps, masks, opacities):
  660. # render map layers
  661. ilayer = 1
  662. for layer in self.layers + self.overlays:
  663. # skip dead or disabled map layers
  664. if layer == None or layer.active == False:
  665. continue
  666. # render if there is no mapfile
  667. if force or \
  668. layer.force_render or \
  669. layer.mapfile == None or \
  670. (not os.path.isfile(layer.mapfile) or not os.path.getsize(layer.mapfile)):
  671. if not layer.Render():
  672. continue
  673. if mapWindow:
  674. # update progress bar
  675. ### wx.SafeYield(mapWindow)
  676. event = wxUpdateProgressBar(value=ilayer)
  677. wx.PostEvent(mapWindow, event)
  678. # add image to compositing list
  679. if layer.type != "overlay":
  680. maps.append(layer.mapfile)
  681. masks.append(layer.maskfile)
  682. opacities.append(str(layer.opacity))
  683. Debug.msg (3, "Map.Render() type=%s, layer=%s " % (layer.type, layer.name))
  684. ilayer += 1
  685. def Render(self, force=False, mapWindow=None, windres=False):
  686. """
  687. Creates final image composite
  688. This function can conditionaly use high-level tools, which
  689. should be avaliable in wxPython library
  690. @param force force rendering
  691. @param reference for MapFrame instance (for progress bar)
  692. @param windres use region resolution (True) otherwise display resolution
  693. @return name of file with rendered image or None
  694. """
  695. maps = []
  696. masks =[]
  697. opacities = []
  698. # use external gisrc if defined
  699. gisrc_orig = os.getenv("GISRC")
  700. if self.gisrc:
  701. os.environ["GISRC"] = self.gisrc
  702. tmp_region = os.getenv("GRASS_REGION")
  703. os.environ["GRASS_REGION"] = self.SetRegion(windres)
  704. os.environ["GRASS_WIDTH"] = str(self.width)
  705. os.environ["GRASS_HEIGHT"] = str(self.height)
  706. os.environ["GRASS_PNG_AUTO_WRITE"] = "TRUE"
  707. os.environ["GRASS_COMPRESSION"] = "0"
  708. os.environ["GRASS_TRUECOLOR"] = "TRUE"
  709. driver = UserSettings.Get(group='display', key='driver', subkey='type')
  710. if driver == 'cairo':
  711. os.environ["GRASS_RENDER_IMMEDIATE"] = "cairo"
  712. elif driver == 'png':
  713. os.environ["GRASS_RENDER_IMMEDIATE"] = "png"
  714. else:
  715. os.environ["GRASS_RENDER_IMMEDIATE"] = "TRUE"
  716. os.environ["GRASS_PNG_READ"] = "FALSE"
  717. self._renderLayers(force, mapWindow, maps, masks, opacities)
  718. # ugly hack for MSYS
  719. if not subprocess.mswindows:
  720. mapstr = ",".join(maps)
  721. maskstr = ",".join(masks)
  722. mapoutstr = self.mapfile
  723. else:
  724. mapstr = ""
  725. for item in maps:
  726. mapstr += item.replace('\\', '/')
  727. mapstr = mapstr.rstrip(',')
  728. maskstr = ""
  729. for item in masks:
  730. maskstr += item.replace('\\', '/')
  731. maskstr = maskstr.rstrip(',')
  732. mapoutstr = self.mapfile.replace('\\', '/')
  733. # compose command
  734. bgcolor = ':'.join(map(str, UserSettings.Get(group='display', key='bgcolor',
  735. subkey='color')))
  736. complist = ["g.pnmcomp",
  737. "in=%s" % ",".join(maps),
  738. "mask=%s" % ",".join(masks),
  739. "opacity=%s" % ",".join(opacities),
  740. "background=%s" % bgcolor,
  741. "width=%s" % str(self.width),
  742. "height=%s" % str(self.height),
  743. "output=%s" % self.mapfile]
  744. # render overlays
  745. if tmp_region:
  746. os.environ["GRASS_REGION"] = tmp_region
  747. else:
  748. del os.environ["GRASS_REGION"]
  749. # run g.pngcomp to get composite image
  750. try:
  751. gcmd.Command(complist)
  752. except gcmd.CmdError, e:
  753. print >> sys.stderr, e
  754. return None
  755. # back to original gisrc
  756. if self.gisrc:
  757. os.environ["GISRC"] = gisrc_orig
  758. Debug.msg (2, "Map.Render() force=%s file=%s" % (force, self.mapfile))
  759. return self.mapfile
  760. def AddLayer(self, type, command, name=None,
  761. l_active=True, l_hidden=False, l_opacity=1.0, l_render=False,
  762. pos=-1):
  763. """
  764. Adds generic map layer to list of layers
  765. @param type layer type ('raster', 'vector', etc.)
  766. @param command GRASS command given as list
  767. @param name layer name
  768. @param l_active layer render only if True
  769. @param l_hidden layer not displayed in layer tree if True
  770. @param l_opacity opacity level range from 0(transparent) - 1(not transparent)
  771. @param l_render render an image if True
  772. @param pos position in layer list (-1 for append)
  773. @return new layer on success
  774. @return None on failure
  775. """
  776. # l_opacity must be <0;1>
  777. if l_opacity < 0: l_opacity = 0
  778. elif l_opacity > 1: l_opacity = 1
  779. layer = MapLayer(type=type, name=name, cmd=command,
  780. active=l_active, hidden=l_hidden, opacity=l_opacity)
  781. # add maplayer to the list of layers
  782. if pos > -1:
  783. self.layers.insert(pos, layer)
  784. else:
  785. self.layers.append(layer)
  786. Debug.msg (3, "Map.AddLayer(): layer=%s" % layer.name)
  787. if l_render:
  788. if not layer.Render():
  789. raise gcmd.GStdError(_("Unable to render map layer <%s>.") % (name))
  790. return layer
  791. def DeleteLayer(self, layer, overlay=False):
  792. """
  793. Removes layer from list of layers
  794. @param layer layer instance in layer tree
  795. @param overlay delete overlay (use self.DeleteOverlay() instead)
  796. @return removed layer on success or None
  797. """
  798. Debug.msg (3, "Map.DeleteLayer(): name=%s" % layer.name)
  799. if overlay:
  800. list = self.overlays
  801. else:
  802. list = self.layers
  803. if layer in list:
  804. if layer.mapfile:
  805. base = os.path.split(layer.mapfile)[0]
  806. mapfile = os.path.split(layer.mapfile)[1]
  807. tempbase = mapfile.split('.')[0]
  808. if base == '' or tempbase == '':
  809. return None
  810. basefile = os.path.join(base, tempbase) + r'.*'
  811. for f in glob.glob(basefile):
  812. os.remove(f)
  813. list.remove(layer)
  814. return layer
  815. return None
  816. def ReorderLayers(self, layerList):
  817. """
  818. Reorder list to match layer tree
  819. @param layerList list of layers
  820. """
  821. self.layers = layerList
  822. layerNameList = ""
  823. for layer in self.layers:
  824. if layer.name:
  825. layerNameList += layer.name + ','
  826. Debug.msg (4, "Map.ReoderLayers(): layers=%s" % \
  827. (layerNameList))
  828. def ChangeLayer(self, layer, render=False, **kargs):
  829. """
  830. Change map layer properties
  831. @param layer map layer instance
  832. @param type layer type ('raster', 'vector', etc.)
  833. @param command GRASS command given as list
  834. @param name layer name
  835. @param active layer render only if True
  836. @param hidden layer not displayed in layer tree if True
  837. @param opacity opacity level range from 0(transparent) - 1(not transparent)
  838. @param render render an image if True
  839. """
  840. Debug.msg (3, "Map.ChangeLayer(): layer=%s" % layer.name)
  841. if kargs.has_key('type'):
  842. layer.SetType(kargs['type']) # check type
  843. if kargs.has_key('command'):
  844. layer.SetCmd(kargs['command'])
  845. if kargs.has_key('name'):
  846. layer.SetName(kargs['name'])
  847. if kargs.has_key('active'):
  848. layer.SetActive(kargs['active'])
  849. if kargs.has_key('hidden'):
  850. layer.SetHidden(kargs['hidden'])
  851. if kargs.has_key('opacity'):
  852. layer.SetOpacity(kargs['opacity'])
  853. if render and not layer.Render():
  854. raise gcmd.GException(_("Unable to render map layer <%s>.") %
  855. (name))
  856. return layer
  857. def ChangeOpacity(self, layer, l_opacity):
  858. """
  859. Changes opacity value of map layer
  860. @param layer layer instance in layer tree
  861. @param l_opacity opacity level <0;1>
  862. """
  863. # l_opacity must be <0;1>
  864. if l_opacity < 0: l_opacity = 0
  865. elif l_opacity > 1: l_opacity = 1
  866. layer.opacity = l_opacity
  867. Debug.msg (3, "Map.ChangeOpacity(): layer=%s, opacity=%f" % \
  868. (layer.name, layer.opacity))
  869. def ChangeLayerActive(self, layer, active):
  870. """
  871. Enable or disable map layer
  872. @param layer layer instance in layer tree
  873. @param active to be rendered (True)
  874. """
  875. layer.active = active
  876. Debug.msg (3, "Map.ChangeLayerActive(): name='%s' -> active=%d" % \
  877. (layer.name, layer.active))
  878. def ChangeLayerName (self, layer, name):
  879. """
  880. Change name of the layer
  881. @param layer layer instance in layer tree
  882. @param name layer name to set up
  883. """
  884. Debug.msg (3, "Map.ChangeLayerName(): from=%s to=%s" % \
  885. (layer.name, name))
  886. layer.name = name
  887. def RemoveLayer(self, name=None, id=None):
  888. """
  889. Removes layer from layer list
  890. Layer is defined by name@mapset or id.
  891. @param name layer name (must be unique)
  892. @param id layer index in layer list
  893. @return removed layer on success
  894. @return None on failure
  895. """
  896. # delete by name
  897. if name:
  898. retlayer = None
  899. for layer in self.layers:
  900. if layer.name == name:
  901. retlayer = layer
  902. os.remove(layer.mapfile)
  903. os.remove(layer.maskfile)
  904. self.layers.remove(layer)
  905. return layer
  906. # del by id
  907. elif id != None:
  908. return self.layers.pop(id)
  909. return None
  910. def GetLayerIndex(self, layer, overlay=False):
  911. """
  912. Get index of layer in layer list.
  913. @param layer layer instace in layer tree
  914. @param overlay use list of overlays instead
  915. @return layer index
  916. @return -1 if layer not found
  917. """
  918. if overlay:
  919. list = self.overlay
  920. else:
  921. list = self.layers
  922. if layer in list:
  923. return list.index(layer)
  924. return -1
  925. def AddOverlay(self, id, type, command,
  926. l_active=True, l_hidden=True, l_opacity=1.0, l_render=False):
  927. """
  928. Adds overlay (grid, barscale, legend, etc.) to list of overlays
  929. @param id overlay id (PseudoDC)
  930. @param type overlay type (barscale, legend)
  931. @param command GRASS command to render overlay
  932. @param l_active overlay activated (True) or disabled (False)
  933. @param l_hidden overlay is not shown in layer tree (if True)
  934. @param l_render render an image (if True)
  935. @return new layer on success
  936. @retutn None on failure
  937. """
  938. Debug.msg (2, "Map.AddOverlay(): cmd=%s, render=%d" % (command, l_render))
  939. overlay = Overlay(id=id, type=type, cmd=command,
  940. active=l_active, hidden=l_hidden, opacity=l_opacity)
  941. # add maplayer to the list of layers
  942. self.overlays.append(overlay)
  943. if l_render and command != '' and not overlay.Render():
  944. raise gcmd.GException(_("Unable render overlay <%s>.") %
  945. (name))
  946. return self.overlays[-1]
  947. def ChangeOverlay(self, id, type, command,
  948. l_active=True, l_hidden=False, l_opacity=1, l_render=False):
  949. """
  950. Change overlay properities
  951. Add new overlay if overlay with 'id' doesn't exist.
  952. @param id overlay id (PseudoDC)
  953. @param type overlay type (barscale, legend)
  954. @param command GRASS command to render overlay
  955. @param l_active overlay activated (True) or disabled (False)
  956. @param l_hidden overlay is not shown in layer tree (if True)
  957. @param l_render render an image (if True)
  958. @return new layer on success
  959. """
  960. overlay = self.GetOverlay(id, list=False)
  961. if overlay is None:
  962. overlay = Overlay(id, type, command,
  963. l_active, l_hidden, l_opacity)
  964. else:
  965. overlay.id = id
  966. overlay.name = type
  967. overlay.cmdlist = command
  968. overlay.active = l_active
  969. overlay.hidden = l_hidden
  970. overlay.opacity = l_opacity
  971. if l_render and command != [] and not overlay.Render():
  972. raise gcmd.GException(_("Unable render overlay <%s>") %
  973. (name))
  974. return overlay
  975. def GetOverlay(self, id, list=False):
  976. """Return overlay(s) with 'id'
  977. @param id overlay id
  978. @param list return list of overlays of True
  979. otherwise suppose 'id' to be unique
  980. @return list of overlays (list=True)
  981. @return overlay (list=False)
  982. @retur None (list=False) if no overlay or more overlays found
  983. """
  984. ovl = []
  985. for overlay in self.overlays:
  986. if overlay.id == id:
  987. ovl.append(overlay)
  988. if not list:
  989. if len(ovl) != 1:
  990. return None
  991. else:
  992. return ovl[0]
  993. return ovl
  994. def DeleteOverlay(self, overlay):
  995. """Delete overlay
  996. @param id overlay id
  997. @return removed overlay on success or None
  998. """
  999. return self.DeleteLayer(overlay, overlay=True)
  1000. def Clean(self):
  1001. """
  1002. Clean layer stack - go trough all layers and remove them from layer list
  1003. Removes also l_mapfile and l_maskfile
  1004. @return 1 on faulure
  1005. @return None on success
  1006. """
  1007. try:
  1008. dir = os.path.dirname(self.mapfile)
  1009. base = os.path.basename(self.mapfile).split('.')[0]
  1010. removepath = os.path.join(dir,base)+r'*'
  1011. for f in glob.glob(removepath):
  1012. os.remove(f)
  1013. for layer in self.layers:
  1014. if layer.mapfile:
  1015. dir = os.path.dirname(layer.mapfile)
  1016. base = os.path.basename(layer.mapfile).split('.')[0]
  1017. removepath = os.path.join(dir,base)+r'*'
  1018. for f in glob.glob(removepath):
  1019. os.remove(f)
  1020. self.layers.remove(layer)
  1021. for overlay in self.overlays:
  1022. if overlay.mapfile:
  1023. dir = os.path.dirname(overlay.mapfile)
  1024. base = os.path.basename(overlay.mapfile).split('.')[0]
  1025. removepath = os.path.join(dir,base)+r'*'
  1026. for f in glob.glob(removepath):
  1027. os.remove(f)
  1028. self.overlays.remove(overlay)
  1029. return None
  1030. except:
  1031. return 1
  1032. self.layers = []
  1033. def ReverseListOfLayers(self):
  1034. """Reverse list of layers"""
  1035. return self.layers.reverse()
  1036. if __name__ == "__main__":
  1037. """
  1038. Test of Display class.
  1039. Usage: display=Render()
  1040. """
  1041. print "Initializing..."
  1042. os.system("g.region -d")
  1043. map = Map()
  1044. map.width = 640
  1045. map.height = 480
  1046. map.AddLayer(item=None,
  1047. type="raster",
  1048. name="elevation.dem",
  1049. command = ["d.rast", "elevation.dem@PERMANENT", "catlist=1000-1500", "-i"],
  1050. l_opacity=.7)
  1051. map.AddLayer(item=None,
  1052. type="vector",
  1053. name="streams",
  1054. command = ["d.vect", "streams@PERMANENT", "color=red", "width=3", "type=line"])
  1055. image = map.Render(force=True)
  1056. if image:
  1057. os.system("display %s" % image)