Skip to content

Commit 7c9d634

Browse files
committed
[processing] rename some algorithms to avoid naming conflicts and
maintain consistency
1 parent 5b7b3a9 commit 7c9d634

File tree

7 files changed

+126
-144
lines changed

7 files changed

+126
-144
lines changed

python/plugins/processing/algs/gdal/ClipByExtent.py renamed to python/plugins/processing/algs/gdal/ClipRasterByExtent.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
"""
44
***************************************************************************
5-
ClipByExtent.py
5+
ClipRasterByExtent.py
66
---------------------
77
Date : September 2013
88
Copyright : (C) 2013 by Alexander Bruy
@@ -44,7 +44,7 @@
4444
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
4545

4646

47-
class ClipByExtent(GdalAlgorithm):
47+
class ClipRasterByExtent(GdalAlgorithm):
4848

4949
INPUT = 'INPUT'
5050
EXTENT = 'PROJWIN'

python/plugins/processing/algs/gdal/ClipByMask.py renamed to python/plugins/processing/algs/gdal/ClipRasterByMask.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
"""
44
***************************************************************************
5-
ClipByMask.py
5+
ClipRasterByMask.py
66
---------------------
77
Date : September 2013
88
Copyright : (C) 2013 by Alexander Bruy
@@ -45,7 +45,7 @@
4545
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
4646

4747

48-
class ClipByMask(GdalAlgorithm):
48+
class ClipRasterByMask(GdalAlgorithm):
4949

5050
INPUT = 'INPUT'
5151
MASK = 'MASK'

python/plugins/processing/algs/gdal/GdalAlgorithmProvider.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,12 @@
3636
from .AssignProjection import AssignProjection
3737
from .aspect import aspect
3838
from .buildvrt import buildvrt
39-
from .ClipByExtent import ClipByExtent
40-
from .ClipByMask import ClipByMask
39+
from .ClipRasterByExtent import ClipRasterByExtent
40+
from .ClipRasterByMask import ClipRasterByMask
4141
from .ColorRelief import ColorRelief
4242
from .contour import contour
4343
from .fillnodata import fillnodata
44+
from .gdalinfo import gdalinfo
4445
from .gdal2tiles import gdal2tiles
4546
from .gdal2xyz import gdal2xyz
4647
from .gdaladdo import gdaladdo
@@ -52,7 +53,6 @@
5253
from .GridLinear import GridLinear
5354
from .GridNearestNeighbor import GridNearestNeighbor
5455
from .hillshade import hillshade
55-
from .information import information
5656
from .nearblack import nearblack
5757
from .pct2rgb import pct2rgb
5858
from .polygonize import polygonize
@@ -73,8 +73,9 @@
7373
# from .gdalcalc import gdalcalc
7474
# from .rasterize_over import rasterize_over
7575

76-
from .ogr2ogrpointsonlines import Ogr2OgrPointsOnLines
77-
from .ogr2ogrtopostgis import Ogr2OgrToPostGis
76+
from .ogrinfo import ogrinfo
77+
from .OgrToPostGis import OgrToPostGis
78+
from .PointsAlongLines import PointsAlongLines
7879

7980
# from .ogr2ogr import Ogr2Ogr
8081
# from .ogr2ogrclip import Ogr2OgrClip
@@ -85,7 +86,6 @@
8586
# from .onesidebuffer import OneSideBuffer
8687
# from .offsetcurve import OffsetCurve
8788
# from .ogr2ogrtabletopostgislist import Ogr2OgrTableToPostGisList
88-
# from .ogrinfo import OgrInfo
8989
# from .ogrsql import OgrSql
9090

9191
pluginPath = os.path.normpath(os.path.join(
@@ -139,11 +139,12 @@ def loadAlgorithms(self):
139139
AssignProjection(),
140140
aspect(),
141141
buildvrt(),
142-
ClipByExtent(),
143-
ClipByMask(),
142+
ClipRasterByExtent(),
143+
ClipRasterByMask(),
144144
ColorRelief(),
145145
contour(),
146146
fillnodata(),
147+
gdalinfo(),
147148
gdal2tiles(),
148149
gdal2xyz(),
149150
gdaladdo(),
@@ -155,7 +156,6 @@ def loadAlgorithms(self):
155156
GridLinear(),
156157
GridNearestNeighbor(),
157158
hillshade(),
158-
information(),
159159
nearblack(),
160160
pct2rgb(),
161161
polygonize(),
@@ -175,9 +175,9 @@ def loadAlgorithms(self):
175175
# gdalcalc(),
176176
# rasterize_over(),
177177
# ----- OGR tools -----
178-
Ogr2OgrPointsOnLines(),
179-
Ogr2OgrToPostGis(),
180-
# OgrInfo(),
178+
ogrinfo(),
179+
OgrToPostGis(),
180+
PointsAlongLines(),
181181
# Ogr2Ogr(),
182182
# Ogr2OgrClip(),
183183
# Ogr2OgrClipExtent(),

python/plugins/processing/algs/gdal/ogr2ogrtopostgis.py renamed to python/plugins/processing/algs/gdal/OgrToPostGis.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
"""
44
***************************************************************************
5-
ogr2ogrtopostgis.py
5+
OgrToPostGis.py
66
---------------------
77
Date : November 2012
88
Copyright : (C) 2012 by Victor Olaya
@@ -16,7 +16,6 @@
1616
* *
1717
***************************************************************************
1818
"""
19-
from builtins import str
2019

2120
__author__ = 'Victor Olaya'
2221
__date__ = 'November 2012'
@@ -40,7 +39,7 @@
4039
from processing.tools.system import isWindows
4140

4241

43-
class Ogr2OgrToPostGis(GdalAlgorithm):
42+
class OgrToPostGis(GdalAlgorithm):
4443

4544
INPUT = 'INPUT'
4645
SHAPE_ENCODING = 'SHAPE_ENCODING'
@@ -309,4 +308,4 @@ def getConsoleCommands(self, parameters, context, feedback):
309308
return commands
310309

311310
def commandName(self):
312-
return "ogr2ogr"
311+
return 'ogr2ogr'

python/plugins/processing/algs/gdal/ogr2ogrpointsonlines.py renamed to python/plugins/processing/algs/gdal/PointsAlongLines.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
"""
44
***************************************************************************
5-
ogr2ogrpointsonlines.py
5+
PointsAlongLines.py
66
---------------------
77
Date : Janaury 2015
88
Copyright : (C) 2015 by Giovanni Manghi
@@ -16,7 +16,6 @@
1616
* *
1717
***************************************************************************
1818
"""
19-
from builtins import str
2019

2120
__author__ = 'Giovanni Manghi'
2221
__date__ = 'January 2015'
@@ -39,7 +38,7 @@
3938
from processing.tools.system import isWindows
4039

4140

42-
class Ogr2OgrPointsOnLines(GdalAlgorithm):
41+
class PointsAlongLines(GdalAlgorithm):
4342

4443
OUTPUT = 'OUTPUT'
4544
INPUT = 'INPUT'
@@ -65,7 +64,7 @@ def initAlgorithm(self, config=None):
6564
self.addParameter(QgsProcessingParameterVectorDestination(self.OUTPUT, self.tr('Points along lines'), QgsProcessing.TypeVectorPoint))
6665

6766
def name(self):
68-
return 'createpointsalonglines'
67+
return 'pointsalonglines'
6968

7069
def displayName(self):
7170
return self.tr('Create points along lines')
@@ -124,4 +123,4 @@ def getConsoleCommands(self, parameters, context, feedback):
124123
return commands
125124

126125
def commandName(self):
127-
return "ogr2ogr"
126+
return 'ogr2ogr'

python/plugins/processing/algs/gdal/information.py renamed to python/plugins/processing/algs/gdal/gdalinfo.py

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
"""
44
***************************************************************************
5-
information.py
5+
gdalinfo.py
66
---------------------
77
Date : August 2012
88
Copyright : (C) 2012 by Victor Olaya
@@ -33,40 +33,36 @@
3333
QgsProcessingParameterFileDestination,
3434
QgsProcessingOutputHtml)
3535
from processing.algs.gdal.GdalAlgorithm import GdalAlgorithm
36-
from processing.core.outputs import OutputHTML
3736
from processing.algs.gdal.GdalUtils import GdalUtils
3837

3938
pluginPath = os.path.split(os.path.split(os.path.dirname(__file__))[0])[0]
4039

4140

42-
class information(GdalAlgorithm):
41+
class gdalinfo(GdalAlgorithm):
4342

4443
INPUT = 'INPUT'
4544
MIN_MAX = 'MIN_MAX'
4645
STATS = 'STATS'
47-
NOGCP = 'NOGCP'
48-
NOMETADATA = 'NOMETADATA'
46+
NO_GCP = 'NOGCP'
47+
NO_METADATA = 'NO_METADATA'
4948
OUTPUT = 'OUTPUT'
5049

51-
def icon(self):
52-
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-info.png'))
53-
5450
def __init__(self):
5551
super().__init__()
5652

5753
def initAlgorithm(self, config=None):
58-
self.addParameter(QgsProcessingParameterRasterLayer(information.INPUT,
54+
self.addParameter(QgsProcessingParameterRasterLayer(self.INPUT,
5955
self.tr('Input layer')))
60-
self.addParameter(QgsProcessingParameterBoolean(information.MIN_MAX,
56+
self.addParameter(QgsProcessingParameterBoolean(self.MIN_MAX,
6157
self.tr('Force computation of the actual min/max values for each band'),
6258
defaultValue=False))
63-
self.addParameter(QgsProcessingParameterBoolean(information.STATS,
59+
self.addParameter(QgsProcessingParameterBoolean(self.STATS,
6460
self.tr('Read and display image statistics (force computation if necessary)'),
6561
defaultValue=False))
66-
self.addParameter(QgsProcessingParameterBoolean(information.NOGCP,
62+
self.addParameter(QgsProcessingParameterBoolean(self.NO_GCP,
6763
self.tr('Suppress GCP info'),
6864
defaultValue=False))
69-
self.addParameter(QgsProcessingParameterBoolean(information.NOMETADATA,
65+
self.addParameter(QgsProcessingParameterBoolean(self.NO_METADATA,
7066
self.tr('Suppress metadata info'),
7167
defaultValue=False))
7268

@@ -79,22 +75,25 @@ def name(self):
7975
return 'gdalinfo'
8076

8177
def displayName(self):
82-
return self.tr('Information')
78+
return self.tr('Raster information')
8379

8480
def group(self):
8581
return self.tr('Raster miscellaneous')
8682

83+
def icon(self):
84+
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-info.png'))
85+
8786
def getConsoleCommands(self, parameters, context, feedback):
8887
arguments = []
89-
if self.parameterAsBool(parameters, information.MIN_MAX, context):
88+
if self.parameterAsBool(parameters, self.MIN_MAX, context):
9089
arguments.append('-mm')
91-
if self.parameterAsBool(parameters, information.STATS, context):
90+
if self.parameterAsBool(parameters, self.STATS, context):
9291
arguments.append('-stats')
93-
if self.parameterAsBool(parameters, information.NOGCP, context):
92+
if self.parameterAsBool(parameters, self.NO_GCP, context):
9493
arguments.append('-nogcp')
95-
if self.parameterAsBool(parameters, information.NOMETADATA, context):
94+
if self.parameterAsBool(parameters, self.NO_METADATA, context):
9695
arguments.append('-nomd')
97-
arguments.append(self.parameterAsRasterLayer(parameters, information.INPUT, context).source())
96+
arguments.append(self.parameterAsRasterLayer(parameters, self.INPUT, context).source())
9897
return ['gdalinfo', GdalUtils.escapeAndJoin(arguments)]
9998

10099
def processAlgorithm(self, parameters, context, feedback):

0 commit comments

Comments
 (0)