summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Wiesmann <yellowcap@users.noreply.github.com>2016-11-11 12:09:38 +0000
committerTim Graham <timograham@gmail.com>2016-11-11 07:09:38 -0500
commit2dc07da497f5ae95ad34a4714e330fae1fa8413c (patch)
treebce3a9161b6be077968b286e83b2c4f13179ac02 /docs
parent501c9930101060d63fb5c25c1dc0154a6c23b775 (diff)
Fixed #27421 -- Added shape, size, and offset controls to GDALRaster constructor.
Thanks Tim Graham for the review.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/gis/gdal.txt33
-rw-r--r--docs/releases/1.11.txt3
2 files changed, 31 insertions, 5 deletions
diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt
index 9bd2df8dad..3f9219dc0d 100644
--- a/docs/ref/contrib/gis/gdal.txt
+++ b/docs/ref/contrib/gis/gdal.txt
@@ -1117,16 +1117,39 @@ blue.
>>> rst = GDALRaster('/path/to/your/raster.tif', write=False)
>>> rst.name
'/path/to/your/raster.tif'
- >>> rst.width, rst.height # This file has 163 x 174 pixels
+ >>> rst.width, rst.height # This file has 163 x 174 pixels
(163, 174)
- >>> rst = GDALRaster({'srid': 4326, 'width': 1, 'height': 2, 'datatype': 1
- ... 'bands': [{'data': [0, 1]}]}) # Creates in-memory raster
+ >>> rst = GDALRaster({ # Creates an in-memory raster
+ ... 'srid': 4326,
+ ... 'width': 4,
+ ... 'height': 4,
+ ... 'datatype': 1,
+ ... 'bands': [{
+ ... 'data': (2, 3),
+ ... 'offset': (1, 1),
+ ... 'size': (2, 2),
+ ... 'shape': (2, 1),
+ ... 'nodata_value': 5,
+ ... }]
+ ... })
>>> rst.srs.srid
4326
>>> rst.width, rst.height
- (1, 2)
+ (4, 4)
>>> rst.bands[0].data()
- array([[0, 1]], dtype=int8)
+ array([[5, 5, 5, 5],
+ [5, 2, 3, 5],
+ [5, 2, 3, 5],
+ [5, 5, 5, 5]], dtype=uint8)
+
+ .. versionchanged:: 1.11
+
+ Added the ability to pass the ``size``, ``shape``, and ``offset``
+ parameters when creating :class:`GDALRaster` objects. The parameters
+ can be passed through the ``ds_input`` dictionary. This allows to
+ finely control initial pixel values. The functionality is similar to
+ the :meth:`GDALBand.data()<django.contrib.gis.gdal.GDALBand.data>`
+ method.
.. attribute:: name
diff --git a/docs/releases/1.11.txt b/docs/releases/1.11.txt
index a612cb0e12..77a1c3ea12 100644
--- a/docs/releases/1.11.txt
+++ b/docs/releases/1.11.txt
@@ -148,6 +148,9 @@ Minor features
* PostGIS migrations can now change field dimensions.
+* Added the ability to pass the `size`, `shape`, and `offset` parameter when
+ creating :class:`~django.contrib.gis.gdal.GDALRaster` objects.
+
:mod:`django.contrib.messages`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~