Upgrade raster enums to enum class, and remove some completely unused

enums
qgis · Dec 16, 2022 · c43b558 · c43b558
1 parent ee3e378
commit c43b558
Show file tree

Hide file tree

Showing 52 changed files with 852 additions and 580 deletions.
diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -2274,3 +2274,165 @@
 Qgis.MetadataDateType.__doc__ = 'Date types for metadata.\n\n.. versionadded:: 3.30\n\n' + '* ``Created``: ' + Qgis.MetadataDateType.Created.__doc__ + '\n' + '* ``Published``: ' + Qgis.MetadataDateType.Published.__doc__ + '\n' + '* ``Revised``: ' + Qgis.MetadataDateType.Revised.__doc__ + '\n' + '* ``Superseded``: ' + Qgis.MetadataDateType.Superseded.__doc__
 # --
 Qgis.MetadataDateType.baseClass = Qgis
+QgsRaster.ColorInterpretation = Qgis.RasterColorInterpretation
+# monkey patching scoped based enum
+QgsRaster.UndefinedColorInterpretation = Qgis.RasterColorInterpretation.Undefined
+QgsRaster.UndefinedColorInterpretation.is_monkey_patched = True
+QgsRaster.UndefinedColorInterpretation.__doc__ = "Undefined"
+QgsRaster.GrayIndex = Qgis.RasterColorInterpretation.GrayIndex
+QgsRaster.GrayIndex.is_monkey_patched = True
+QgsRaster.GrayIndex.__doc__ = "Grayscale"
+QgsRaster.PaletteIndex = Qgis.RasterColorInterpretation.PaletteIndex
+QgsRaster.PaletteIndex.is_monkey_patched = True
+QgsRaster.PaletteIndex.__doc__ = "Paletted (see associated color table)"
+QgsRaster.RedBand = Qgis.RasterColorInterpretation.RedBand
+QgsRaster.RedBand.is_monkey_patched = True
+QgsRaster.RedBand.__doc__ = "Red band of RGBA image"
+QgsRaster.GreenBand = Qgis.RasterColorInterpretation.GreenBand
+QgsRaster.GreenBand.is_monkey_patched = True
+QgsRaster.GreenBand.__doc__ = "Green band of RGBA image"
+QgsRaster.BlueBand = Qgis.RasterColorInterpretation.BlueBand
+QgsRaster.BlueBand.is_monkey_patched = True
+QgsRaster.BlueBand.__doc__ = "Blue band of RGBA image"
+QgsRaster.AlphaBand = Qgis.RasterColorInterpretation.AlphaBand
+QgsRaster.AlphaBand.is_monkey_patched = True
+QgsRaster.AlphaBand.__doc__ = "Alpha (0=transparent, 255=opaque)"
+QgsRaster.HueBand = Qgis.RasterColorInterpretation.HueBand
+QgsRaster.HueBand.is_monkey_patched = True
+QgsRaster.HueBand.__doc__ = "Hue band of HLS image"
+QgsRaster.SaturationBand = Qgis.RasterColorInterpretation.SaturationBand
+QgsRaster.SaturationBand.is_monkey_patched = True
+QgsRaster.SaturationBand.__doc__ = "Saturation band of HLS image"
+QgsRaster.LightnessBand = Qgis.RasterColorInterpretation.LightnessBand
+QgsRaster.LightnessBand.is_monkey_patched = True
+QgsRaster.LightnessBand.__doc__ = "Lightness band of HLS image"
+QgsRaster.CyanBand = Qgis.RasterColorInterpretation.CyanBand
+QgsRaster.CyanBand.is_monkey_patched = True
+QgsRaster.CyanBand.__doc__ = "Cyan band of CMYK image"
+QgsRaster.MagentaBand = Qgis.RasterColorInterpretation.MagentaBand
+QgsRaster.MagentaBand.is_monkey_patched = True
+QgsRaster.MagentaBand.__doc__ = "Magenta band of CMYK image"
+QgsRaster.YellowBand = Qgis.RasterColorInterpretation.YellowBand
+QgsRaster.YellowBand.is_monkey_patched = True
+QgsRaster.YellowBand.__doc__ = "Yellow band of CMYK image"
+QgsRaster.BlackBand = Qgis.RasterColorInterpretation.BlackBand
+QgsRaster.BlackBand.is_monkey_patched = True
+QgsRaster.BlackBand.__doc__ = "Black band of CMLY image"
+QgsRaster.YCbCr_YBand = Qgis.RasterColorInterpretation.YCbCr_YBand
+QgsRaster.YCbCr_YBand.is_monkey_patched = True
+QgsRaster.YCbCr_YBand.__doc__ = "Y Luminance"
+QgsRaster.YCbCr_CbBand = Qgis.RasterColorInterpretation.YCbCr_CbBand
+QgsRaster.YCbCr_CbBand.is_monkey_patched = True
+QgsRaster.YCbCr_CbBand.__doc__ = "Cb Chroma"
+QgsRaster.YCbCr_CrBand = Qgis.RasterColorInterpretation.YCbCr_CrBand
+QgsRaster.YCbCr_CrBand.is_monkey_patched = True
+QgsRaster.YCbCr_CrBand.__doc__ = "Cr Chroma"
+QgsRaster.ContinuousPalette = Qgis.RasterColorInterpretation.ContinuousPalette
+QgsRaster.ContinuousPalette.is_monkey_patched = True
+QgsRaster.ContinuousPalette.__doc__ = "Continuous palette, QGIS addition, GRASS"
+Qgis.RasterColorInterpretation.__doc__ = 'Raster color interpretation.\n\nThis is a modified copy of the GDAL GDALColorInterp enum.\n\n.. note::\n\n   Prior to QGIS 3.30 this was available as :py:class:`QgsRaster`.ColorInterpretation\n\n.. versionadded:: 3.30\n\n' + '* ``UndefinedColorInterpretation``: ' + Qgis.RasterColorInterpretation.Undefined.__doc__ + '\n' + '* ``GrayIndex``: ' + Qgis.RasterColorInterpretation.GrayIndex.__doc__ + '\n' + '* ``PaletteIndex``: ' + Qgis.RasterColorInterpretation.PaletteIndex.__doc__ + '\n' + '* ``RedBand``: ' + Qgis.RasterColorInterpretation.RedBand.__doc__ + '\n' + '* ``GreenBand``: ' + Qgis.RasterColorInterpretation.GreenBand.__doc__ + '\n' + '* ``BlueBand``: ' + Qgis.RasterColorInterpretation.BlueBand.__doc__ + '\n' + '* ``AlphaBand``: ' + Qgis.RasterColorInterpretation.AlphaBand.__doc__ + '\n' + '* ``HueBand``: ' + Qgis.RasterColorInterpretation.HueBand.__doc__ + '\n' + '* ``SaturationBand``: ' + Qgis.RasterColorInterpretation.SaturationBand.__doc__ + '\n' + '* ``LightnessBand``: ' + Qgis.RasterColorInterpretation.LightnessBand.__doc__ + '\n' + '* ``CyanBand``: ' + Qgis.RasterColorInterpretation.CyanBand.__doc__ + '\n' + '* ``MagentaBand``: ' + Qgis.RasterColorInterpretation.MagentaBand.__doc__ + '\n' + '* ``YellowBand``: ' + Qgis.RasterColorInterpretation.YellowBand.__doc__ + '\n' + '* ``BlackBand``: ' + Qgis.RasterColorInterpretation.BlackBand.__doc__ + '\n' + '* ``YCbCr_YBand``: ' + Qgis.RasterColorInterpretation.YCbCr_YBand.__doc__ + '\n' + '* ``YCbCr_CbBand``: ' + Qgis.RasterColorInterpretation.YCbCr_CbBand.__doc__ + '\n' + '* ``YCbCr_CrBand``: ' + Qgis.RasterColorInterpretation.YCbCr_CrBand.__doc__ + '\n' + '* ``ContinuousPalette``: ' + Qgis.RasterColorInterpretation.ContinuousPalette.__doc__
+# --
+Qgis.RasterColorInterpretation.baseClass = Qgis
+QgsRasterLayer.LayerType = Qgis.RasterLayerType
+# monkey patching scoped based enum
+QgsRasterLayer.GrayOrUndefined = Qgis.RasterLayerType.GrayOrUndefined
+QgsRasterLayer.GrayOrUndefined.is_monkey_patched = True
+QgsRasterLayer.GrayOrUndefined.__doc__ = "Gray or undefined"
+QgsRasterLayer.Palette = Qgis.RasterLayerType.Palette
+QgsRasterLayer.Palette.is_monkey_patched = True
+QgsRasterLayer.Palette.__doc__ = "Palette"
+QgsRasterLayer.Multiband = Qgis.RasterLayerType.MultiBand
+QgsRasterLayer.Multiband.is_monkey_patched = True
+QgsRasterLayer.Multiband.__doc__ = "Multi band"
+QgsRasterLayer.ColorLayer = Qgis.RasterLayerType.SingleBandColorData
+QgsRasterLayer.ColorLayer.is_monkey_patched = True
+QgsRasterLayer.ColorLayer.__doc__ = "Single band containing color data"
+Qgis.RasterLayerType.__doc__ = 'Raster layer types.\n\n.. note::\n\n   Prior to QGIS 3.30 this was available as :py:class:`QgsRasterLayer`.LayerType\n\n.. versionadded:: 3.30\n\n' + '* ``GrayOrUndefined``: ' + Qgis.RasterLayerType.GrayOrUndefined.__doc__ + '\n' + '* ``Palette``: ' + Qgis.RasterLayerType.Palette.__doc__ + '\n' + '* ``Multiband``: ' + Qgis.RasterLayerType.MultiBand.__doc__ + '\n' + '* ``ColorLayer``: ' + Qgis.RasterLayerType.SingleBandColorData.__doc__
+# --
+Qgis.RasterLayerType.baseClass = Qgis
+QgsRaster.DrawingStyle = Qgis.RasterDrawingStyle
+# monkey patching scoped based enum
+QgsRaster.UndefinedDrawingStyle = Qgis.RasterDrawingStyle.Undefined
+QgsRaster.UndefinedDrawingStyle.is_monkey_patched = True
+QgsRaster.UndefinedDrawingStyle.__doc__ = "Undefined"
+QgsRaster.SingleBandGray = Qgis.RasterDrawingStyle.SingleBandGray
+QgsRaster.SingleBandGray.is_monkey_patched = True
+QgsRaster.SingleBandGray.__doc__ = "A single band image drawn as a range of gray colors"
+QgsRaster.SingleBandPseudoColor = Qgis.RasterDrawingStyle.SingleBandPseudoColor
+QgsRaster.SingleBandPseudoColor.is_monkey_patched = True
+QgsRaster.SingleBandPseudoColor.__doc__ = "A single band image drawn using a pseudocolor algorithm"
+QgsRaster.PalettedColor = Qgis.RasterDrawingStyle.PalettedColor
+QgsRaster.PalettedColor.is_monkey_patched = True
+QgsRaster.PalettedColor.__doc__ = "A \"Palette\" image drawn using color table"
+QgsRaster.PalettedSingleBandGray = Qgis.RasterDrawingStyle.PalettedSingleBandGray
+QgsRaster.PalettedSingleBandGray.is_monkey_patched = True
+QgsRaster.PalettedSingleBandGray.__doc__ = "A \"Palette\" layer drawn in gray scale"
+QgsRaster.PalettedSingleBandPseudoColor = Qgis.RasterDrawingStyle.PalettedSingleBandPseudoColor
+QgsRaster.PalettedSingleBandPseudoColor.is_monkey_patched = True
+QgsRaster.PalettedSingleBandPseudoColor.__doc__ = "A \"Palette\" layerdrawn using a pseudocolor algorithm"
+QgsRaster.PalettedMultiBandColor = Qgis.RasterDrawingStyle.PalettedMultiBandColor
+QgsRaster.PalettedMultiBandColor.is_monkey_patched = True
+QgsRaster.PalettedMultiBandColor.__doc__ = "Currently not supported"
+QgsRaster.MultiBandSingleBandGray = Qgis.RasterDrawingStyle.MultiBandSingleBandGray
+QgsRaster.MultiBandSingleBandGray.is_monkey_patched = True
+QgsRaster.MultiBandSingleBandGray.__doc__ = "A layer containing 2 or more bands, but a single band drawn as a range of gray colors"
+QgsRaster.MultiBandSingleBandPseudoColor = Qgis.RasterDrawingStyle.MultiBandSingleBandPseudoColor
+QgsRaster.MultiBandSingleBandPseudoColor.is_monkey_patched = True
+QgsRaster.MultiBandSingleBandPseudoColor.__doc__ = "A layer containing 2 or more bands, but a single band drawn using a pseudocolor algorithm"
+QgsRaster.MultiBandColor = Qgis.RasterDrawingStyle.MultiBandColor
+QgsRaster.MultiBandColor.is_monkey_patched = True
+QgsRaster.MultiBandColor.__doc__ = "A layer containing 2 or more bands, mapped to RGB color space. In the case of a multiband with only two bands, one band will be mapped to more than one color."
+QgsRaster.SingleBandColorDataStyle = Qgis.RasterDrawingStyle.SingleBandColorData
+QgsRaster.SingleBandColorDataStyle.is_monkey_patched = True
+QgsRaster.SingleBandColorDataStyle.__doc__ = "ARGB values rendered directly"
+Qgis.RasterDrawingStyle.__doc__ = 'Raster drawing styles.\n\n.. note::\n\n   Prior to QGIS 3.30 this was available as :py:class:`QgsRaster`.DrawingStyle\n\n.. versionadded:: 3.30\n\n' + '* ``UndefinedDrawingStyle``: ' + Qgis.RasterDrawingStyle.Undefined.__doc__ + '\n' + '* ``SingleBandGray``: ' + Qgis.RasterDrawingStyle.SingleBandGray.__doc__ + '\n' + '* ``SingleBandPseudoColor``: ' + Qgis.RasterDrawingStyle.SingleBandPseudoColor.__doc__ + '\n' + '* ``PalettedColor``: ' + Qgis.RasterDrawingStyle.PalettedColor.__doc__ + '\n' + '* ``PalettedSingleBandGray``: ' + Qgis.RasterDrawingStyle.PalettedSingleBandGray.__doc__ + '\n' + '* ``PalettedSingleBandPseudoColor``: ' + Qgis.RasterDrawingStyle.PalettedSingleBandPseudoColor.__doc__ + '\n' + '* ``PalettedMultiBandColor``: ' + Qgis.RasterDrawingStyle.PalettedMultiBandColor.__doc__ + '\n' + '* ``MultiBandSingleBandGray``: ' + Qgis.RasterDrawingStyle.MultiBandSingleBandGray.__doc__ + '\n' + '* ``MultiBandSingleBandPseudoColor``: ' + Qgis.RasterDrawingStyle.MultiBandSingleBandPseudoColor.__doc__ + '\n' + '* ``MultiBandColor``: ' + Qgis.RasterDrawingStyle.MultiBandColor.__doc__ + '\n' + '* ``SingleBandColorDataStyle``: ' + Qgis.RasterDrawingStyle.SingleBandColorData.__doc__
+# --
+Qgis.RasterDrawingStyle.baseClass = Qgis
+QgsRaster.RasterPyramidsFormat = Qgis.RasterPyramidFormat
+# monkey patching scoped based enum
+QgsRaster.PyramidsGTiff = Qgis.RasterPyramidFormat.GeoTiff
+QgsRaster.PyramidsGTiff.is_monkey_patched = True
+QgsRaster.PyramidsGTiff.__doc__ = "Geotiff .ovr (external)"
+QgsRaster.PyramidsInternal = Qgis.RasterPyramidFormat.Internal
+QgsRaster.PyramidsInternal.is_monkey_patched = True
+QgsRaster.PyramidsInternal.__doc__ = "Internal"
+QgsRaster.PyramidsErdas = Qgis.RasterPyramidFormat.Erdas
+QgsRaster.PyramidsErdas.is_monkey_patched = True
+QgsRaster.PyramidsErdas.__doc__ = "Erdas Image .aux (external)"
+Qgis.RasterPyramidFormat.__doc__ = 'Raster pyramid formats.\n\n.. note::\n\n   Prior to QGIS 3.30 this was available as :py:class:`QgsRaster`.RasterPyramidsFormat\n\n.. versionadded:: 3.30\n\n' + '* ``PyramidsGTiff``: ' + Qgis.RasterPyramidFormat.GeoTiff.__doc__ + '\n' + '* ``PyramidsInternal``: ' + Qgis.RasterPyramidFormat.Internal.__doc__ + '\n' + '* ``PyramidsErdas``: ' + Qgis.RasterPyramidFormat.Erdas.__doc__
+# --
+Qgis.RasterPyramidFormat.baseClass = Qgis
+QgsRaster.RasterBuildPyramids = Qgis.RasterBuildPyramidOption
+# monkey patching scoped based enum
+QgsRaster.PyramidsFlagNo = Qgis.RasterBuildPyramidOption.No
+QgsRaster.PyramidsFlagNo.is_monkey_patched = True
+QgsRaster.PyramidsFlagNo.__doc__ = "Never"
+QgsRaster.PyramidsFlagYes = Qgis.RasterBuildPyramidOption.Yes
+QgsRaster.PyramidsFlagYes.is_monkey_patched = True
+QgsRaster.PyramidsFlagYes.__doc__ = "Yes"
+QgsRaster.PyramidsCopyExisting = Qgis.RasterBuildPyramidOption.CopyExisting
+QgsRaster.PyramidsCopyExisting.is_monkey_patched = True
+QgsRaster.PyramidsCopyExisting.__doc__ = "Copy existing"
+Qgis.RasterBuildPyramidOption.__doc__ = 'Raster pyramid building options.\n\n.. note::\n\n   Prior to QGIS 3.30 this was available as :py:class:`QgsRaster`.RasterBuildPyramids\n\n.. versionadded:: 3.30\n\n' + '* ``PyramidsFlagNo``: ' + Qgis.RasterBuildPyramidOption.No.__doc__ + '\n' + '* ``PyramidsFlagYes``: ' + Qgis.RasterBuildPyramidOption.Yes.__doc__ + '\n' + '* ``PyramidsCopyExisting``: ' + Qgis.RasterBuildPyramidOption.CopyExisting.__doc__
+# --
+Qgis.RasterBuildPyramidOption.baseClass = Qgis
+QgsRaster.IdentifyFormat = Qgis.RasterIdentifyFormat
+# monkey patching scoped based enum
+QgsRaster.IdentifyFormatUndefined = Qgis.RasterIdentifyFormat.Undefined
+QgsRaster.IdentifyFormatUndefined.is_monkey_patched = True
+QgsRaster.IdentifyFormatUndefined.__doc__ = "Undefined"
+QgsRaster.IdentifyFormatValue = Qgis.RasterIdentifyFormat.Value
+QgsRaster.IdentifyFormatValue.is_monkey_patched = True
+QgsRaster.IdentifyFormatValue.__doc__ = "Numerical pixel value"
+QgsRaster.IdentifyFormatText = Qgis.RasterIdentifyFormat.Text
+QgsRaster.IdentifyFormatText.is_monkey_patched = True
+QgsRaster.IdentifyFormatText.__doc__ = "WMS text"
+QgsRaster.IdentifyFormatHtml = Qgis.RasterIdentifyFormat.Html
+QgsRaster.IdentifyFormatHtml.is_monkey_patched = True
+QgsRaster.IdentifyFormatHtml.__doc__ = "WMS HTML"
+QgsRaster.IdentifyFormatFeature = Qgis.RasterIdentifyFormat.Feature
+QgsRaster.IdentifyFormatFeature.is_monkey_patched = True
+QgsRaster.IdentifyFormatFeature.__doc__ = "WMS GML/JSON -> feature"
+Qgis.RasterIdentifyFormat.__doc__ = 'Raster identify formats.\n\n.. note::\n\n   Prior to QGIS 3.30 this was available as :py:class:`QgsRaster`.IdentifyFormat\n\n.. versionadded:: 3.30\n\n' + '* ``IdentifyFormatUndefined``: ' + Qgis.RasterIdentifyFormat.Undefined.__doc__ + '\n' + '* ``IdentifyFormatValue``: ' + Qgis.RasterIdentifyFormat.Value.__doc__ + '\n' + '* ``IdentifyFormatText``: ' + Qgis.RasterIdentifyFormat.Text.__doc__ + '\n' + '* ``IdentifyFormatHtml``: ' + Qgis.RasterIdentifyFormat.Html.__doc__ + '\n' + '* ``IdentifyFormatFeature``: ' + Qgis.RasterIdentifyFormat.Feature.__doc__
+# --
+Qgis.RasterIdentifyFormat.baseClass = Qgis
diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -1510,6 +1510,74 @@ The development version
       Superseded,
     };
 
+    enum class RasterColorInterpretation
+      {
+      Undefined,
+      GrayIndex,
+      PaletteIndex,
+      RedBand,
+      GreenBand,
+      BlueBand,
+      AlphaBand,
+      HueBand,
+      SaturationBand,
+      LightnessBand,
+      CyanBand,
+      MagentaBand,
+      YellowBand,
+      BlackBand,
+      YCbCr_YBand,
+      YCbCr_CbBand,
+      YCbCr_CrBand,
+      ContinuousPalette
+    };
+
+    enum class RasterLayerType
+      {
+      GrayOrUndefined,
+      Palette,
+      MultiBand,
+      SingleBandColorData,
+    };
+
+    enum class RasterDrawingStyle
+      {
+      Undefined,
+      SingleBandGray,
+      SingleBandPseudoColor,
+      PalettedColor,
+      PalettedSingleBandGray,
+      PalettedSingleBandPseudoColor,
+      PalettedMultiBandColor,
+      MultiBandSingleBandGray,
+      MultiBandSingleBandPseudoColor,
+      MultiBandColor,
+      SingleBandColorData,
+    };
+
+    enum class RasterPyramidFormat
+      {
+      GeoTiff,
+      Internal,
+      Erdas
+    };
+
+    enum class RasterBuildPyramidOption
+      {
+      No,
+      Yes,
+      CopyExisting
+    };
+
+    enum class RasterIdentifyFormat
+      {
+      Undefined,
+      Value,
+      Text,
+      Html,
+      Feature,
+    };
+
     static const double DEFAULT_SEARCH_RADIUS_MM;
 
     static const float DEFAULT_MAPTOPIXEL_THRESHOLD;

diff --git a/python/core/auto_generated/raster/qgsraster.sip.in b/python/core/auto_generated/raster/qgsraster.sip.in
@@ -20,65 +20,6 @@ Raster namespace.
 #include "qgsraster.h"
 %End
   public:
-    enum ColorInterpretation
-    {
-      UndefinedColorInterpretation,
-      GrayIndex,
-      PaletteIndex,
-      RedBand,
-      GreenBand,
-      BlueBand,
-      AlphaBand,
-      HueBand,
-      SaturationBand,
-      LightnessBand,
-      CyanBand,
-      MagentaBand,
-      YellowBand,
-      BlackBand,
-      YCbCr_YBand,
-      YCbCr_CbBand,
-      YCbCr_CrBand,
-      ContinuousPalette
-    };
-
-    enum IdentifyFormat
-    {
-      IdentifyFormatUndefined,
-      IdentifyFormatValue,
-      IdentifyFormatText,
-      IdentifyFormatHtml,
-      IdentifyFormatFeature,
-    };
-
-    enum RasterBuildPyramids
-    {
-      PyramidsFlagNo,
-      PyramidsFlagYes,
-      PyramidsCopyExisting
-    };
-
-    enum RasterPyramidsFormat
-    {
-      PyramidsGTiff,
-      PyramidsInternal,
-      PyramidsErdas
-    };
-
-    enum DrawingStyle
-    {
-      UndefinedDrawingStyle,
-      SingleBandGray,
-      SingleBandPseudoColor,
-      PalettedColor,
-      PalettedSingleBandGray,
-      PalettedSingleBandPseudoColor,
-      PalettedMultiBandColor,
-      MultiBandSingleBandGray,
-      MultiBandSingleBandPseudoColor,
-      MultiBandColor,
-      SingleBandColorDataStyle,
-    };
 
 
     static double representableValue( double value, Qgis::DataType dataType );