test_raster.py 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982
  1. import os
  2. import shutil
  3. import struct
  4. import tempfile
  5. import zipfile
  6. from pathlib import Path
  7. from unittest import mock
  8. from django.contrib.gis.gdal import GDALRaster, SpatialReference
  9. from django.contrib.gis.gdal.error import GDALException
  10. from django.contrib.gis.gdal.raster.band import GDALBand
  11. from django.contrib.gis.shortcuts import numpy
  12. from django.test import SimpleTestCase
  13. from ..data.rasters.textrasters import JSON_RASTER
  14. class GDALRasterTests(SimpleTestCase):
  15. """
  16. Test a GDALRaster instance created from a file (GeoTiff).
  17. """
  18. def setUp(self):
  19. self.rs_path = os.path.join(
  20. os.path.dirname(__file__), "../data/rasters/raster.tif"
  21. )
  22. self.rs = GDALRaster(self.rs_path)
  23. def test_gdalraster_input_as_path(self):
  24. rs_path = Path(__file__).parent.parent / "data" / "rasters" / "raster.tif"
  25. rs = GDALRaster(rs_path)
  26. self.assertEqual(str(rs_path), rs.name)
  27. def test_rs_name_repr(self):
  28. self.assertEqual(self.rs_path, self.rs.name)
  29. self.assertRegex(repr(self.rs), r"<Raster object at 0x\w+>")
  30. def test_rs_driver(self):
  31. self.assertEqual(self.rs.driver.name, "GTiff")
  32. def test_rs_size(self):
  33. self.assertEqual(self.rs.width, 163)
  34. self.assertEqual(self.rs.height, 174)
  35. def test_rs_srs(self):
  36. self.assertEqual(self.rs.srs.srid, 3086)
  37. self.assertEqual(self.rs.srs.units, (1.0, "metre"))
  38. def test_rs_srid(self):
  39. rast = GDALRaster(
  40. {
  41. "width": 16,
  42. "height": 16,
  43. "srid": 4326,
  44. }
  45. )
  46. self.assertEqual(rast.srid, 4326)
  47. rast.srid = 3086
  48. self.assertEqual(rast.srid, 3086)
  49. def test_geotransform_and_friends(self):
  50. # Assert correct values for file based raster
  51. self.assertEqual(
  52. self.rs.geotransform,
  53. [511700.4680706557, 100.0, 0.0, 435103.3771231986, 0.0, -100.0],
  54. )
  55. self.assertEqual(self.rs.origin, [511700.4680706557, 435103.3771231986])
  56. self.assertEqual(self.rs.origin.x, 511700.4680706557)
  57. self.assertEqual(self.rs.origin.y, 435103.3771231986)
  58. self.assertEqual(self.rs.scale, [100.0, -100.0])
  59. self.assertEqual(self.rs.scale.x, 100.0)
  60. self.assertEqual(self.rs.scale.y, -100.0)
  61. self.assertEqual(self.rs.skew, [0, 0])
  62. self.assertEqual(self.rs.skew.x, 0)
  63. self.assertEqual(self.rs.skew.y, 0)
  64. # Create in-memory rasters and change gtvalues
  65. rsmem = GDALRaster(JSON_RASTER)
  66. # geotransform accepts both floats and ints
  67. rsmem.geotransform = [0.0, 1.0, 2.0, 3.0, 4.0, 5.0]
  68. self.assertEqual(rsmem.geotransform, [0.0, 1.0, 2.0, 3.0, 4.0, 5.0])
  69. rsmem.geotransform = range(6)
  70. self.assertEqual(rsmem.geotransform, [float(x) for x in range(6)])
  71. self.assertEqual(rsmem.origin, [0, 3])
  72. self.assertEqual(rsmem.origin.x, 0)
  73. self.assertEqual(rsmem.origin.y, 3)
  74. self.assertEqual(rsmem.scale, [1, 5])
  75. self.assertEqual(rsmem.scale.x, 1)
  76. self.assertEqual(rsmem.scale.y, 5)
  77. self.assertEqual(rsmem.skew, [2, 4])
  78. self.assertEqual(rsmem.skew.x, 2)
  79. self.assertEqual(rsmem.skew.y, 4)
  80. self.assertEqual(rsmem.width, 5)
  81. self.assertEqual(rsmem.height, 5)
  82. def test_geotransform_bad_inputs(self):
  83. rsmem = GDALRaster(JSON_RASTER)
  84. error_geotransforms = [
  85. [1, 2],
  86. [1, 2, 3, 4, 5, "foo"],
  87. [1, 2, 3, 4, 5, 6, "foo"],
  88. ]
  89. msg = "Geotransform must consist of 6 numeric values."
  90. for geotransform in error_geotransforms:
  91. with self.subTest(i=geotransform), self.assertRaisesMessage(
  92. ValueError, msg
  93. ):
  94. rsmem.geotransform = geotransform
  95. def test_rs_extent(self):
  96. self.assertEqual(
  97. self.rs.extent,
  98. (
  99. 511700.4680706557,
  100. 417703.3771231986,
  101. 528000.4680706557,
  102. 435103.3771231986,
  103. ),
  104. )
  105. def test_rs_bands(self):
  106. self.assertEqual(len(self.rs.bands), 1)
  107. self.assertIsInstance(self.rs.bands[0], GDALBand)
  108. def test_memory_based_raster_creation(self):
  109. # Create uint8 raster with full pixel data range (0-255)
  110. rast = GDALRaster(
  111. {
  112. "datatype": 1,
  113. "width": 16,
  114. "height": 16,
  115. "srid": 4326,
  116. "bands": [
  117. {
  118. "data": range(256),
  119. "nodata_value": 255,
  120. }
  121. ],
  122. }
  123. )
  124. # Get array from raster
  125. result = rast.bands[0].data()
  126. if numpy:
  127. result = result.flatten().tolist()
  128. # Assert data is same as original input
  129. self.assertEqual(result, list(range(256)))
  130. def test_file_based_raster_creation(self):
  131. # Prepare tempfile
  132. rstfile = tempfile.NamedTemporaryFile(suffix=".tif")
  133. # Create file-based raster from scratch
  134. GDALRaster(
  135. {
  136. "datatype": self.rs.bands[0].datatype(),
  137. "driver": "tif",
  138. "name": rstfile.name,
  139. "width": 163,
  140. "height": 174,
  141. "nr_of_bands": 1,
  142. "srid": self.rs.srs.wkt,
  143. "origin": (self.rs.origin.x, self.rs.origin.y),
  144. "scale": (self.rs.scale.x, self.rs.scale.y),
  145. "skew": (self.rs.skew.x, self.rs.skew.y),
  146. "bands": [
  147. {
  148. "data": self.rs.bands[0].data(),
  149. "nodata_value": self.rs.bands[0].nodata_value,
  150. }
  151. ],
  152. }
  153. )
  154. # Reload newly created raster from file
  155. restored_raster = GDALRaster(rstfile.name)
  156. # Presence of TOWGS84 depend on GDAL/Proj versions.
  157. self.assertEqual(
  158. restored_raster.srs.wkt.replace("TOWGS84[0,0,0,0,0,0,0],", ""),
  159. self.rs.srs.wkt.replace("TOWGS84[0,0,0,0,0,0,0],", ""),
  160. )
  161. self.assertEqual(restored_raster.geotransform, self.rs.geotransform)
  162. if numpy:
  163. numpy.testing.assert_equal(
  164. restored_raster.bands[0].data(), self.rs.bands[0].data()
  165. )
  166. else:
  167. self.assertEqual(restored_raster.bands[0].data(), self.rs.bands[0].data())
  168. def test_nonexistent_file(self):
  169. msg = 'Unable to read raster source input "nonexistent.tif".'
  170. with self.assertRaisesMessage(GDALException, msg):
  171. GDALRaster("nonexistent.tif")
  172. def test_vsi_raster_creation(self):
  173. # Open a raster as a file object.
  174. with open(self.rs_path, "rb") as dat:
  175. # Instantiate a raster from the file binary buffer.
  176. vsimem = GDALRaster(dat.read())
  177. # The data of the in-memory file is equal to the source file.
  178. result = vsimem.bands[0].data()
  179. target = self.rs.bands[0].data()
  180. if numpy:
  181. result = result.flatten().tolist()
  182. target = target.flatten().tolist()
  183. self.assertEqual(result, target)
  184. def test_vsi_raster_deletion(self):
  185. path = "/vsimem/raster.tif"
  186. # Create a vsi-based raster from scratch.
  187. vsimem = GDALRaster(
  188. {
  189. "name": path,
  190. "driver": "tif",
  191. "width": 4,
  192. "height": 4,
  193. "srid": 4326,
  194. "bands": [
  195. {
  196. "data": range(16),
  197. }
  198. ],
  199. }
  200. )
  201. # The virtual file exists.
  202. rst = GDALRaster(path)
  203. self.assertEqual(rst.width, 4)
  204. # Delete GDALRaster.
  205. del vsimem
  206. del rst
  207. # The virtual file has been removed.
  208. msg = 'Could not open the datasource at "/vsimem/raster.tif"'
  209. with self.assertRaisesMessage(GDALException, msg):
  210. GDALRaster(path)
  211. def test_vsi_invalid_buffer_error(self):
  212. msg = "Failed creating VSI raster from the input buffer."
  213. with self.assertRaisesMessage(GDALException, msg):
  214. GDALRaster(b"not-a-raster-buffer")
  215. def test_vsi_buffer_property(self):
  216. # Create a vsi-based raster from scratch.
  217. rast = GDALRaster(
  218. {
  219. "name": "/vsimem/raster.tif",
  220. "driver": "tif",
  221. "width": 4,
  222. "height": 4,
  223. "srid": 4326,
  224. "bands": [
  225. {
  226. "data": range(16),
  227. }
  228. ],
  229. }
  230. )
  231. # Do a round trip from raster to buffer to raster.
  232. result = GDALRaster(rast.vsi_buffer).bands[0].data()
  233. if numpy:
  234. result = result.flatten().tolist()
  235. # Band data is equal to nodata value except on input block of ones.
  236. self.assertEqual(result, list(range(16)))
  237. # The vsi buffer is None for rasters that are not vsi based.
  238. self.assertIsNone(self.rs.vsi_buffer)
  239. def test_vsi_vsizip_filesystem(self):
  240. rst_zipfile = tempfile.NamedTemporaryFile(suffix=".zip")
  241. with zipfile.ZipFile(rst_zipfile, mode="w") as zf:
  242. zf.write(self.rs_path, "raster.tif")
  243. rst_path = "/vsizip/" + os.path.join(rst_zipfile.name, "raster.tif")
  244. rst = GDALRaster(rst_path)
  245. self.assertEqual(rst.driver.name, self.rs.driver.name)
  246. self.assertEqual(rst.name, rst_path)
  247. self.assertIs(rst.is_vsi_based, True)
  248. self.assertIsNone(rst.vsi_buffer)
  249. def test_offset_size_and_shape_on_raster_creation(self):
  250. rast = GDALRaster(
  251. {
  252. "datatype": 1,
  253. "width": 4,
  254. "height": 4,
  255. "srid": 4326,
  256. "bands": [
  257. {
  258. "data": (1,),
  259. "offset": (1, 1),
  260. "size": (2, 2),
  261. "shape": (1, 1),
  262. "nodata_value": 2,
  263. }
  264. ],
  265. }
  266. )
  267. # Get array from raster.
  268. result = rast.bands[0].data()
  269. if numpy:
  270. result = result.flatten().tolist()
  271. # Band data is equal to nodata value except on input block of ones.
  272. self.assertEqual(result, [2, 2, 2, 2, 2, 1, 1, 2, 2, 1, 1, 2, 2, 2, 2, 2])
  273. def test_set_nodata_value_on_raster_creation(self):
  274. # Create raster filled with nodata values.
  275. rast = GDALRaster(
  276. {
  277. "datatype": 1,
  278. "width": 2,
  279. "height": 2,
  280. "srid": 4326,
  281. "bands": [{"nodata_value": 23}],
  282. }
  283. )
  284. # Get array from raster.
  285. result = rast.bands[0].data()
  286. if numpy:
  287. result = result.flatten().tolist()
  288. # All band data is equal to nodata value.
  289. self.assertEqual(result, [23] * 4)
  290. def test_set_nodata_none_on_raster_creation(self):
  291. # Create raster without data and without nodata value.
  292. rast = GDALRaster(
  293. {
  294. "datatype": 1,
  295. "width": 2,
  296. "height": 2,
  297. "srid": 4326,
  298. "bands": [{"nodata_value": None}],
  299. }
  300. )
  301. # Get array from raster.
  302. result = rast.bands[0].data()
  303. if numpy:
  304. result = result.flatten().tolist()
  305. # Band data is equal to zero because no nodata value has been specified.
  306. self.assertEqual(result, [0] * 4)
  307. def test_raster_metadata_property(self):
  308. data = self.rs.metadata
  309. self.assertEqual(data["DEFAULT"], {"AREA_OR_POINT": "Area"})
  310. self.assertEqual(data["IMAGE_STRUCTURE"], {"INTERLEAVE": "BAND"})
  311. # Create file-based raster from scratch
  312. source = GDALRaster(
  313. {
  314. "datatype": 1,
  315. "width": 2,
  316. "height": 2,
  317. "srid": 4326,
  318. "bands": [{"data": range(4), "nodata_value": 99}],
  319. }
  320. )
  321. # Set metadata on raster and on a band.
  322. metadata = {
  323. "DEFAULT": {"OWNER": "Django", "VERSION": "1.0", "AREA_OR_POINT": "Point"},
  324. }
  325. source.metadata = metadata
  326. source.bands[0].metadata = metadata
  327. self.assertEqual(source.metadata["DEFAULT"], metadata["DEFAULT"])
  328. self.assertEqual(source.bands[0].metadata["DEFAULT"], metadata["DEFAULT"])
  329. # Update metadata on raster.
  330. metadata = {
  331. "DEFAULT": {"VERSION": "2.0"},
  332. }
  333. source.metadata = metadata
  334. self.assertEqual(source.metadata["DEFAULT"]["VERSION"], "2.0")
  335. # Remove metadata on raster.
  336. metadata = {
  337. "DEFAULT": {"OWNER": None},
  338. }
  339. source.metadata = metadata
  340. self.assertNotIn("OWNER", source.metadata["DEFAULT"])
  341. def test_raster_info_accessor(self):
  342. infos = self.rs.info
  343. # Data
  344. info_lines = [line.strip() for line in infos.split("\n") if line.strip() != ""]
  345. for line in [
  346. "Driver: GTiff/GeoTIFF",
  347. "Files: {}".format(self.rs_path),
  348. "Size is 163, 174",
  349. "Origin = (511700.468070655711927,435103.377123198588379)",
  350. "Pixel Size = (100.000000000000000,-100.000000000000000)",
  351. "Metadata:",
  352. "AREA_OR_POINT=Area",
  353. "Image Structure Metadata:",
  354. "INTERLEAVE=BAND",
  355. "Band 1 Block=163x50 Type=Byte, ColorInterp=Gray",
  356. "NoData Value=15",
  357. ]:
  358. self.assertIn(line, info_lines)
  359. for line in [
  360. r"Upper Left \( 511700.468, 435103.377\) "
  361. r'\( 82d51\'46.1\d"W, 27d55\' 1.5\d"N\)',
  362. r"Lower Left \( 511700.468, 417703.377\) "
  363. r'\( 82d51\'52.0\d"W, 27d45\'37.5\d"N\)',
  364. r"Upper Right \( 528000.468, 435103.377\) "
  365. r'\( 82d41\'48.8\d"W, 27d54\'56.3\d"N\)',
  366. r"Lower Right \( 528000.468, 417703.377\) "
  367. r'\( 82d41\'55.5\d"W, 27d45\'32.2\d"N\)',
  368. r"Center \( 519850.468, 426403.377\) "
  369. r'\( 82d46\'50.6\d"W, 27d50\'16.9\d"N\)',
  370. ]:
  371. self.assertRegex(infos, line)
  372. # CRS (skip the name because string depends on the GDAL/Proj versions).
  373. self.assertIn("NAD83 / Florida GDL Albers", infos)
  374. def test_compressed_file_based_raster_creation(self):
  375. rstfile = tempfile.NamedTemporaryFile(suffix=".tif")
  376. # Make a compressed copy of an existing raster.
  377. compressed = self.rs.warp(
  378. {"papsz_options": {"compress": "packbits"}, "name": rstfile.name}
  379. )
  380. # Check physically if compression worked.
  381. self.assertLess(os.path.getsize(compressed.name), os.path.getsize(self.rs.name))
  382. # Create file-based raster with options from scratch.
  383. compressed = GDALRaster(
  384. {
  385. "datatype": 1,
  386. "driver": "tif",
  387. "name": rstfile.name,
  388. "width": 40,
  389. "height": 40,
  390. "srid": 3086,
  391. "origin": (500000, 400000),
  392. "scale": (100, -100),
  393. "skew": (0, 0),
  394. "bands": [
  395. {
  396. "data": range(40 ^ 2),
  397. "nodata_value": 255,
  398. }
  399. ],
  400. "papsz_options": {
  401. "compress": "packbits",
  402. "pixeltype": "signedbyte",
  403. "blockxsize": 23,
  404. "blockysize": 23,
  405. },
  406. }
  407. )
  408. # Check if options used on creation are stored in metadata.
  409. # Reopening the raster ensures that all metadata has been written
  410. # to the file.
  411. compressed = GDALRaster(compressed.name)
  412. self.assertEqual(
  413. compressed.metadata["IMAGE_STRUCTURE"]["COMPRESSION"],
  414. "PACKBITS",
  415. )
  416. self.assertEqual(
  417. compressed.bands[0].metadata["IMAGE_STRUCTURE"]["PIXELTYPE"], "SIGNEDBYTE"
  418. )
  419. self.assertIn("Block=40x23", compressed.info)
  420. def test_raster_warp(self):
  421. # Create in memory raster
  422. source = GDALRaster(
  423. {
  424. "datatype": 1,
  425. "driver": "MEM",
  426. "name": "sourceraster",
  427. "width": 4,
  428. "height": 4,
  429. "nr_of_bands": 1,
  430. "srid": 3086,
  431. "origin": (500000, 400000),
  432. "scale": (100, -100),
  433. "skew": (0, 0),
  434. "bands": [
  435. {
  436. "data": range(16),
  437. "nodata_value": 255,
  438. }
  439. ],
  440. }
  441. )
  442. # Test altering the scale, width, and height of a raster
  443. data = {
  444. "scale": [200, -200],
  445. "width": 2,
  446. "height": 2,
  447. }
  448. target = source.warp(data)
  449. self.assertEqual(target.width, data["width"])
  450. self.assertEqual(target.height, data["height"])
  451. self.assertEqual(target.scale, data["scale"])
  452. self.assertEqual(target.bands[0].datatype(), source.bands[0].datatype())
  453. self.assertEqual(target.name, "sourceraster_copy.MEM")
  454. result = target.bands[0].data()
  455. if numpy:
  456. result = result.flatten().tolist()
  457. self.assertEqual(result, [5, 7, 13, 15])
  458. # Test altering the name and datatype (to float)
  459. data = {
  460. "name": "/path/to/targetraster.tif",
  461. "datatype": 6,
  462. }
  463. target = source.warp(data)
  464. self.assertEqual(target.bands[0].datatype(), 6)
  465. self.assertEqual(target.name, "/path/to/targetraster.tif")
  466. self.assertEqual(target.driver.name, "MEM")
  467. result = target.bands[0].data()
  468. if numpy:
  469. result = result.flatten().tolist()
  470. self.assertEqual(
  471. result,
  472. [
  473. 0.0,
  474. 1.0,
  475. 2.0,
  476. 3.0,
  477. 4.0,
  478. 5.0,
  479. 6.0,
  480. 7.0,
  481. 8.0,
  482. 9.0,
  483. 10.0,
  484. 11.0,
  485. 12.0,
  486. 13.0,
  487. 14.0,
  488. 15.0,
  489. ],
  490. )
  491. def test_raster_warp_nodata_zone(self):
  492. # Create in memory raster.
  493. source = GDALRaster(
  494. {
  495. "datatype": 1,
  496. "driver": "MEM",
  497. "width": 4,
  498. "height": 4,
  499. "srid": 3086,
  500. "origin": (500000, 400000),
  501. "scale": (100, -100),
  502. "skew": (0, 0),
  503. "bands": [
  504. {
  505. "data": range(16),
  506. "nodata_value": 23,
  507. }
  508. ],
  509. }
  510. )
  511. # Warp raster onto a location that does not cover any pixels of the original.
  512. result = source.warp({"origin": (200000, 200000)}).bands[0].data()
  513. if numpy:
  514. result = result.flatten().tolist()
  515. # The result is an empty raster filled with the correct nodata value.
  516. self.assertEqual(result, [23] * 16)
  517. def test_raster_clone(self):
  518. rstfile = tempfile.NamedTemporaryFile(suffix=".tif")
  519. tests = [
  520. ("MEM", "", 23), # In memory raster.
  521. ("tif", rstfile.name, 99), # In file based raster.
  522. ]
  523. for driver, name, nodata_value in tests:
  524. with self.subTest(driver=driver):
  525. source = GDALRaster(
  526. {
  527. "datatype": 1,
  528. "driver": driver,
  529. "name": name,
  530. "width": 4,
  531. "height": 4,
  532. "srid": 3086,
  533. "origin": (500000, 400000),
  534. "scale": (100, -100),
  535. "skew": (0, 0),
  536. "bands": [
  537. {
  538. "data": range(16),
  539. "nodata_value": nodata_value,
  540. }
  541. ],
  542. }
  543. )
  544. clone = source.clone()
  545. self.assertNotEqual(clone.name, source.name)
  546. self.assertEqual(clone._write, source._write)
  547. self.assertEqual(clone.srs.srid, source.srs.srid)
  548. self.assertEqual(clone.width, source.width)
  549. self.assertEqual(clone.height, source.height)
  550. self.assertEqual(clone.origin, source.origin)
  551. self.assertEqual(clone.scale, source.scale)
  552. self.assertEqual(clone.skew, source.skew)
  553. self.assertIsNot(clone, source)
  554. def test_raster_transform(self):
  555. tests = [
  556. 3086,
  557. "3086",
  558. SpatialReference(3086),
  559. ]
  560. for srs in tests:
  561. with self.subTest(srs=srs):
  562. # Prepare tempfile and nodata value.
  563. rstfile = tempfile.NamedTemporaryFile(suffix=".tif")
  564. ndv = 99
  565. # Create in file based raster.
  566. source = GDALRaster(
  567. {
  568. "datatype": 1,
  569. "driver": "tif",
  570. "name": rstfile.name,
  571. "width": 5,
  572. "height": 5,
  573. "nr_of_bands": 1,
  574. "srid": 4326,
  575. "origin": (-5, 5),
  576. "scale": (2, -2),
  577. "skew": (0, 0),
  578. "bands": [
  579. {
  580. "data": range(25),
  581. "nodata_value": ndv,
  582. }
  583. ],
  584. }
  585. )
  586. target = source.transform(srs)
  587. # Reload data from disk.
  588. target = GDALRaster(target.name)
  589. self.assertEqual(target.srs.srid, 3086)
  590. self.assertEqual(target.width, 7)
  591. self.assertEqual(target.height, 7)
  592. self.assertEqual(target.bands[0].datatype(), source.bands[0].datatype())
  593. self.assertAlmostEqual(target.origin[0], 9124842.791079799, 3)
  594. self.assertAlmostEqual(target.origin[1], 1589911.6476407414, 3)
  595. self.assertAlmostEqual(target.scale[0], 223824.82664250192, 3)
  596. self.assertAlmostEqual(target.scale[1], -223824.82664250192, 3)
  597. self.assertEqual(target.skew, [0, 0])
  598. result = target.bands[0].data()
  599. if numpy:
  600. result = result.flatten().tolist()
  601. # The reprojection of a raster that spans over a large area
  602. # skews the data matrix and might introduce nodata values.
  603. self.assertEqual(
  604. result,
  605. [
  606. ndv,
  607. ndv,
  608. ndv,
  609. ndv,
  610. 4,
  611. ndv,
  612. ndv,
  613. ndv,
  614. ndv,
  615. 2,
  616. 3,
  617. 9,
  618. ndv,
  619. ndv,
  620. ndv,
  621. 1,
  622. 2,
  623. 8,
  624. 13,
  625. 19,
  626. ndv,
  627. 0,
  628. 6,
  629. 6,
  630. 12,
  631. 18,
  632. 18,
  633. 24,
  634. ndv,
  635. 10,
  636. 11,
  637. 16,
  638. 22,
  639. 23,
  640. ndv,
  641. ndv,
  642. ndv,
  643. 15,
  644. 21,
  645. 22,
  646. ndv,
  647. ndv,
  648. ndv,
  649. ndv,
  650. 20,
  651. ndv,
  652. ndv,
  653. ndv,
  654. ndv,
  655. ],
  656. )
  657. def test_raster_transform_clone(self):
  658. with mock.patch.object(GDALRaster, "clone") as mocked_clone:
  659. # Create in file based raster.
  660. rstfile = tempfile.NamedTemporaryFile(suffix=".tif")
  661. source = GDALRaster(
  662. {
  663. "datatype": 1,
  664. "driver": "tif",
  665. "name": rstfile.name,
  666. "width": 5,
  667. "height": 5,
  668. "nr_of_bands": 1,
  669. "srid": 4326,
  670. "origin": (-5, 5),
  671. "scale": (2, -2),
  672. "skew": (0, 0),
  673. "bands": [
  674. {
  675. "data": range(25),
  676. "nodata_value": 99,
  677. }
  678. ],
  679. }
  680. )
  681. # transform() returns a clone because it is the same SRID and
  682. # driver.
  683. source.transform(4326)
  684. self.assertEqual(mocked_clone.call_count, 1)
  685. def test_raster_transform_clone_name(self):
  686. # Create in file based raster.
  687. rstfile = tempfile.NamedTemporaryFile(suffix=".tif")
  688. source = GDALRaster(
  689. {
  690. "datatype": 1,
  691. "driver": "tif",
  692. "name": rstfile.name,
  693. "width": 5,
  694. "height": 5,
  695. "nr_of_bands": 1,
  696. "srid": 4326,
  697. "origin": (-5, 5),
  698. "scale": (2, -2),
  699. "skew": (0, 0),
  700. "bands": [
  701. {
  702. "data": range(25),
  703. "nodata_value": 99,
  704. }
  705. ],
  706. }
  707. )
  708. clone_name = rstfile.name + "_respect_name.GTiff"
  709. target = source.transform(4326, name=clone_name)
  710. self.assertEqual(target.name, clone_name)
  711. class GDALBandTests(SimpleTestCase):
  712. rs_path = os.path.join(os.path.dirname(__file__), "../data/rasters/raster.tif")
  713. def test_band_data(self):
  714. rs = GDALRaster(self.rs_path)
  715. band = rs.bands[0]
  716. self.assertEqual(band.width, 163)
  717. self.assertEqual(band.height, 174)
  718. self.assertEqual(band.description, "")
  719. self.assertEqual(band.datatype(), 1)
  720. self.assertEqual(band.datatype(as_string=True), "GDT_Byte")
  721. self.assertEqual(band.color_interp(), 1)
  722. self.assertEqual(band.color_interp(as_string=True), "GCI_GrayIndex")
  723. self.assertEqual(band.nodata_value, 15)
  724. if numpy:
  725. data = band.data()
  726. assert_array = numpy.loadtxt(
  727. os.path.join(
  728. os.path.dirname(__file__), "../data/rasters/raster.numpy.txt"
  729. )
  730. )
  731. numpy.testing.assert_equal(data, assert_array)
  732. self.assertEqual(data.shape, (band.height, band.width))
  733. def test_band_statistics(self):
  734. with tempfile.TemporaryDirectory() as tmp_dir:
  735. rs_path = os.path.join(tmp_dir, "raster.tif")
  736. shutil.copyfile(self.rs_path, rs_path)
  737. rs = GDALRaster(rs_path)
  738. band = rs.bands[0]
  739. pam_file = rs_path + ".aux.xml"
  740. smin, smax, smean, sstd = band.statistics(approximate=True)
  741. self.assertEqual(smin, 0)
  742. self.assertEqual(smax, 9)
  743. self.assertAlmostEqual(smean, 2.842331288343558)
  744. self.assertAlmostEqual(sstd, 2.3965567248965356)
  745. smin, smax, smean, sstd = band.statistics(approximate=False, refresh=True)
  746. self.assertEqual(smin, 0)
  747. self.assertEqual(smax, 9)
  748. self.assertAlmostEqual(smean, 2.828326634228898)
  749. self.assertAlmostEqual(sstd, 2.4260526986669095)
  750. self.assertEqual(band.min, 0)
  751. self.assertEqual(band.max, 9)
  752. self.assertAlmostEqual(band.mean, 2.828326634228898)
  753. self.assertAlmostEqual(band.std, 2.4260526986669095)
  754. # Statistics are persisted into PAM file on band close
  755. rs = band = None
  756. self.assertTrue(os.path.isfile(pam_file))
  757. def _remove_aux_file(self):
  758. pam_file = self.rs_path + ".aux.xml"
  759. if os.path.isfile(pam_file):
  760. os.remove(pam_file)
  761. def test_read_mode_error(self):
  762. # Open raster in read mode
  763. rs = GDALRaster(self.rs_path, write=False)
  764. band = rs.bands[0]
  765. self.addCleanup(self._remove_aux_file)
  766. # Setting attributes in write mode raises exception in the _flush method
  767. with self.assertRaises(GDALException):
  768. setattr(band, "nodata_value", 10)
  769. def test_band_data_setters(self):
  770. # Create in-memory raster and get band
  771. rsmem = GDALRaster(
  772. {
  773. "datatype": 1,
  774. "driver": "MEM",
  775. "name": "mem_rst",
  776. "width": 10,
  777. "height": 10,
  778. "nr_of_bands": 1,
  779. "srid": 4326,
  780. }
  781. )
  782. bandmem = rsmem.bands[0]
  783. # Set nodata value
  784. bandmem.nodata_value = 99
  785. self.assertEqual(bandmem.nodata_value, 99)
  786. # Set data for entire dataset
  787. bandmem.data(range(100))
  788. if numpy:
  789. numpy.testing.assert_equal(
  790. bandmem.data(), numpy.arange(100).reshape(10, 10)
  791. )
  792. else:
  793. self.assertEqual(bandmem.data(), list(range(100)))
  794. # Prepare data for setting values in subsequent tests
  795. block = list(range(100, 104))
  796. packed_block = struct.pack("<" + "B B B B", *block)
  797. # Set data from list
  798. bandmem.data(block, (1, 1), (2, 2))
  799. result = bandmem.data(offset=(1, 1), size=(2, 2))
  800. if numpy:
  801. numpy.testing.assert_equal(result, numpy.array(block).reshape(2, 2))
  802. else:
  803. self.assertEqual(result, block)
  804. # Set data from packed block
  805. bandmem.data(packed_block, (1, 1), (2, 2))
  806. result = bandmem.data(offset=(1, 1), size=(2, 2))
  807. if numpy:
  808. numpy.testing.assert_equal(result, numpy.array(block).reshape(2, 2))
  809. else:
  810. self.assertEqual(result, block)
  811. # Set data from bytes
  812. bandmem.data(bytes(packed_block), (1, 1), (2, 2))
  813. result = bandmem.data(offset=(1, 1), size=(2, 2))
  814. if numpy:
  815. numpy.testing.assert_equal(result, numpy.array(block).reshape(2, 2))
  816. else:
  817. self.assertEqual(result, block)
  818. # Set data from bytearray
  819. bandmem.data(bytearray(packed_block), (1, 1), (2, 2))
  820. result = bandmem.data(offset=(1, 1), size=(2, 2))
  821. if numpy:
  822. numpy.testing.assert_equal(result, numpy.array(block).reshape(2, 2))
  823. else:
  824. self.assertEqual(result, block)
  825. # Set data from memoryview
  826. bandmem.data(memoryview(packed_block), (1, 1), (2, 2))
  827. result = bandmem.data(offset=(1, 1), size=(2, 2))
  828. if numpy:
  829. numpy.testing.assert_equal(result, numpy.array(block).reshape(2, 2))
  830. else:
  831. self.assertEqual(result, block)
  832. # Set data from numpy array
  833. if numpy:
  834. bandmem.data(numpy.array(block, dtype="int8").reshape(2, 2), (1, 1), (2, 2))
  835. numpy.testing.assert_equal(
  836. bandmem.data(offset=(1, 1), size=(2, 2)),
  837. numpy.array(block).reshape(2, 2),
  838. )
  839. # Test json input data
  840. rsmemjson = GDALRaster(JSON_RASTER)
  841. bandmemjson = rsmemjson.bands[0]
  842. if numpy:
  843. numpy.testing.assert_equal(
  844. bandmemjson.data(), numpy.array(range(25)).reshape(5, 5)
  845. )
  846. else:
  847. self.assertEqual(bandmemjson.data(), list(range(25)))
  848. def test_band_statistics_automatic_refresh(self):
  849. rsmem = GDALRaster(
  850. {
  851. "srid": 4326,
  852. "width": 2,
  853. "height": 2,
  854. "bands": [{"data": [0] * 4, "nodata_value": 99}],
  855. }
  856. )
  857. band = rsmem.bands[0]
  858. # Populate statistics cache
  859. self.assertEqual(band.statistics(), (0, 0, 0, 0))
  860. # Change data
  861. band.data([1, 1, 0, 0])
  862. # Statistics are properly updated
  863. self.assertEqual(band.statistics(), (0.0, 1.0, 0.5, 0.5))
  864. # Change nodata_value
  865. band.nodata_value = 0
  866. # Statistics are properly updated
  867. self.assertEqual(band.statistics(), (1.0, 1.0, 1.0, 0.0))
  868. def test_band_statistics_empty_band(self):
  869. rsmem = GDALRaster(
  870. {
  871. "srid": 4326,
  872. "width": 1,
  873. "height": 1,
  874. "bands": [{"data": [0], "nodata_value": 0}],
  875. }
  876. )
  877. self.assertEqual(rsmem.bands[0].statistics(), (None, None, None, None))
  878. def test_band_delete_nodata(self):
  879. rsmem = GDALRaster(
  880. {
  881. "srid": 4326,
  882. "width": 1,
  883. "height": 1,
  884. "bands": [{"data": [0], "nodata_value": 1}],
  885. }
  886. )
  887. rsmem.bands[0].nodata_value = None
  888. self.assertIsNone(rsmem.bands[0].nodata_value)
  889. def test_band_data_replication(self):
  890. band = GDALRaster(
  891. {
  892. "srid": 4326,
  893. "width": 3,
  894. "height": 3,
  895. "bands": [{"data": range(10, 19), "nodata_value": 0}],
  896. }
  897. ).bands[0]
  898. # Variations for input (data, shape, expected result).
  899. combos = (
  900. ([1], (1, 1), [1] * 9),
  901. (range(3), (1, 3), [0, 0, 0, 1, 1, 1, 2, 2, 2]),
  902. (range(3), (3, 1), [0, 1, 2, 0, 1, 2, 0, 1, 2]),
  903. )
  904. for combo in combos:
  905. band.data(combo[0], shape=combo[1])
  906. if numpy:
  907. numpy.testing.assert_equal(
  908. band.data(), numpy.array(combo[2]).reshape(3, 3)
  909. )
  910. else:
  911. self.assertEqual(band.data(), list(combo[2]))