summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/gis/gdal.txt16
-rw-r--r--docs/releases/2.0.txt4
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/ref/contrib/gis/gdal.txt b/docs/ref/contrib/gis/gdal.txt
index 832d91977c..68aca347cc 100644
--- a/docs/ref/contrib/gis/gdal.txt
+++ b/docs/ref/contrib/gis/gdal.txt
@@ -1551,6 +1551,22 @@ blue.
``GDT_UInt32``, ``GDT_Int32``, ``GDT_Float32``, ``GDT_Float64``,
``GDT_CInt16``, ``GDT_CInt32``, ``GDT_CFloat32``, and ``GDT_CFloat64``.
+ .. method:: color_interp(as_string=False)
+
+ .. versionadded:: 2.0
+
+ The color interpretation for the band, as an integer between 0and 16.
+ If ``as_string`` is ``True``, the data type is returned as a string
+ with the following possible values:
+ ``GCI_Undefined``, ``GCI_GrayIndex``, ``GCI_PaletteIndex``,
+ ``GCI_RedBand``, ``GCI_GreenBand``, ``GCI_BlueBand``, ``GCI_AlphaBand``,
+ ``GCI_HueBand``, ``GCI_SaturationBand``, ``GCI_LightnessBand``,
+ ``GCI_CyanBand``, ``GCI_MagentaBand``, ``GCI_YellowBand``,
+ ``GCI_BlackBand``, ``GCI_YCbCr_YBand``, ``GCI_YCbCr_CbBand``, and
+ ``GCI_YCbCr_CrBand``. ``GCI_YCbCr_CrBand`` also represents ``GCI_Max``
+ because both correspond to the integer 16, but only ``GCI_YCbCr_CrBand``
+ is returned as a string.
+
.. method:: data(data=None, offset=None, size=None, shape=None)
The accessor to the pixel values of the ``GDALBand``. Returns the complete
diff --git a/docs/releases/2.0.txt b/docs/releases/2.0.txt
index 457e69ea9e..71d41b664c 100644
--- a/docs/releases/2.0.txt
+++ b/docs/releases/2.0.txt
@@ -144,6 +144,10 @@ Minor features
GDAL's internal virtual filesystem. Rasters can now be :ref:`created from and
converted to binary data <gdal-raster-vsimem>` in-memory.
+* The new :meth:`GDALBand.color_interp()
+ <django.contrib.gis.gdal.GDALBand.color_interp>` method returns the color
+ interpretation for the band.
+
:mod:`django.contrib.messages`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~