render.py 40 KB

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