Skip to content

Commit

Permalink
Move alg character definitions to __init__
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Jun 5, 2017
1 parent 134c04b commit 77ab933
Show file tree
Hide file tree
Showing 208 changed files with 1,772 additions and 1,577 deletions.
25 changes: 13 additions & 12 deletions python/plugins/processing/algs/exampleprovider/ExampleAlgorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,8 @@ class ExampleAlgorithm(GeoAlgorithm):
OUTPUT_LAYER = 'OUTPUT_LAYER'
INPUT_LAYER = 'INPUT_LAYER'

def name(self):
# Unique (non-user visible) name of algorithm
return 'create_copy_of_layer'

def displayName(self):
# The name that the user will see in the toolbox
return self.tr('Create copy of layer')

def group(self):
return self.tr('Algorithms for vector layers')

def defineCharacteristics(self):
def __init__(self):
super().__init__()
"""Here we define the inputs and output of the algorithm, along
with some other properties.
"""
Expand All @@ -79,6 +69,17 @@ def defineCharacteristics(self):
self.addOutput(OutputVector(self.OUTPUT_LAYER,
self.tr('Output layer with selected features')))

def name(self):
# Unique (non-user visible) name of algorithm
return 'create_copy_of_layer'

def displayName(self):
# The name that the user will see in the toolbox
return self.tr('Create copy of layer')

def group(self):
return self.tr('Algorithms for vector layers')

def processAlgorithm(self, context, feedback):
"""Here is where the processing itself takes place.
:param context:
Expand Down
15 changes: 8 additions & 7 deletions python/plugins/processing/algs/gdal/AssignProjection.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ class AssignProjection(GdalAlgorithm):
CRS = 'CRS'
OUTPUT = 'OUTPUT'

def __init__(self):
super().__init__()
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterCrs(self.CRS,
self.tr('Desired CRS'), ''))

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Layer with projection'), True))

def name(self):
return 'assignprojection'

Expand All @@ -58,13 +66,6 @@ def icon(self):
def group(self):
return self.tr('Raster projections')

def defineCharacteristics(self):
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterCrs(self.CRS,
self.tr('Desired CRS'), ''))

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Layer with projection'), True))

def getConsoleCommands(self):
fileName = self.getParameterValue(self.INPUT)
crs = self.getParameterValue(self.CRS)
Expand Down
27 changes: 14 additions & 13 deletions python/plugins/processing/algs/gdal/ClipByExtent.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,8 @@ class ClipByExtent(GdalAlgorithm):
RTYPE = 'RTYPE'
TYPE = ['Byte', 'Int16', 'UInt16', 'UInt32', 'Int32', 'Float32', 'Float64']

def name(self):
return 'cliprasterbyextent'

def displayName(self):
return self.tr('Clip raster by extent')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-clip.png'))

def group(self):
return self.tr('Raster extraction')

def defineCharacteristics(self):
def __init__(self):
super().__init__()
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer')))
self.addParameter(ParameterString(self.NO_DATA,
self.tr("Nodata value, leave blank to take the nodata value from input"),
Expand All @@ -82,6 +71,18 @@ def defineCharacteristics(self):

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Clipped (extent)')))

def name(self):
return 'cliprasterbyextent'

def displayName(self):
return self.tr('Clip raster by extent')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-clip.png'))

def group(self):
return self.tr('Raster extraction')

def getConsoleCommands(self):
out = self.getOutputValue(self.OUTPUT)
noData = self.getParameterValue(self.NO_DATA)
Expand Down
27 changes: 14 additions & 13 deletions python/plugins/processing/algs/gdal/ClipByMask.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,8 @@ class ClipByMask(GdalAlgorithm):
RTYPE = 'RTYPE'
TYPE = ['Byte', 'Int16', 'UInt16', 'UInt32', 'Int32', 'Float32', 'Float64']

def name(self):
return 'cliprasterbymasklayer'

def displayName(self):
return self.tr('Clip raster by mask layer')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-clip.png'))

def group(self):
return self.tr('Raster extraction')

def defineCharacteristics(self):
def __init__(self):
super().__init__()
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterVector(self.MASK, self.tr('Mask layer'),
[dataobjects.TYPE_VECTOR_POLYGON]))
Expand All @@ -101,6 +90,18 @@ def defineCharacteristics(self):

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Clipped (mask)')))

def name(self):
return 'cliprasterbymasklayer'

def displayName(self):
return self.tr('Clip raster by mask layer')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'raster-clip.png'))

def group(self):
return self.tr('Raster extraction')

def getConsoleCommands(self):
out = self.getOutputValue(self.OUTPUT)
mask = self.getParameterValue(self.MASK)
Expand Down
21 changes: 11 additions & 10 deletions python/plugins/processing/algs/gdal/ColorRelief.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,8 @@ class ColorRelief(GdalAlgorithm):

MATCHING_MODES = ['"0,0,0,0" RGBA', 'Exact color', 'Nearest color']

def name(self):
return 'colorrelief'

def displayName(self):
return self.tr('Color relief')

def group(self):
return self.tr('Raster analysis')

def defineCharacteristics(self):
def __init__(self):
super().__init__()
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer')))
self.addParameter(ParameterNumber(
self.BAND, self.tr('Band number'), 1, 99, 1))
Expand All @@ -69,6 +61,15 @@ def defineCharacteristics(self):

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Color relief')))

def name(self):
return 'colorrelief'

def displayName(self):
return self.tr('Color relief')

def group(self):
return self.tr('Raster analysis')

def getConsoleCommands(self):
arguments = ['color-relief']
arguments.append(str(self.getParameterValue(self.INPUT)))
Expand Down
27 changes: 14 additions & 13 deletions python/plugins/processing/algs/gdal/GridAverage.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,8 @@ class GridAverage(GdalAlgorithm):

TYPE = ['Byte', 'Int16', 'UInt16', 'UInt32', 'Int32', 'Float32', 'Float64']

def name(self):
return 'gridaverage'

def displayName(self):
return self.tr('Grid (Moving average)')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))

def group(self):
return self.tr('Raster analysis')

def defineCharacteristics(self):
def __init__(self):
super().__init__()
self.addParameter(ParameterVector(self.INPUT,
self.tr('Input layer'), [dataobjects.TYPE_VECTOR_POINT]))
self.addParameter(ParameterTableField(self.Z_FIELD,
Expand All @@ -89,6 +78,18 @@ def defineCharacteristics(self):

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Interpolated moving average')))

def name(self):
return 'gridaverage'

def displayName(self):
return self.tr('Grid (Moving average)')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))

def group(self):
return self.tr('Raster analysis')

def getConsoleCommands(self):
arguments = ['-l']
arguments.append(
Expand Down
27 changes: 14 additions & 13 deletions python/plugins/processing/algs/gdal/GridDataMetrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,8 @@ class GridDataMetrics(GdalAlgorithm):
DATA_METRICS = ['Minimum', 'Maximum', 'Range', 'Count', 'Average distance',
'Average distance between points']

def name(self):
return 'griddatametrics'

def displayName(self):
return self.tr('Grid (Data metrics)')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))

def group(self):
return self.tr('Raster analysis')

def defineCharacteristics(self):
def __init__(self):
super().__init__()
self.addParameter(ParameterVector(self.INPUT,
self.tr('Input layer'), [dataobjects.TYPE_VECTOR_POINT]))
self.addParameter(ParameterTableField(self.Z_FIELD,
Expand All @@ -96,6 +85,18 @@ def defineCharacteristics(self):

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Interpolated metrics')))

def name(self):
return 'griddatametrics'

def displayName(self):
return self.tr('Grid (Data metrics)')

def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))

def group(self):
return self.tr('Raster analysis')

def getConsoleCommands(self):
arguments = ['-l']
arguments.append(
Expand Down
21 changes: 11 additions & 10 deletions python/plugins/processing/algs/gdal/GridInvDist.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,8 @@ class GridInvDist(GdalAlgorithm):
def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))

def name(self):
return 'gridinvdist'

def displayName(self):
return self.tr('Grid (Inverse distance to a power)')

def group(self):
return self.tr('Raster analysis')

def defineCharacteristics(self):
def __init__(self):
super().__init__()
self.addParameter(ParameterVector(self.INPUT,
self.tr('Input layer'), [dataobjects.TYPE_VECTOR_POINT]))
self.addParameter(ParameterTableField(self.Z_FIELD,
Expand All @@ -99,6 +91,15 @@ def defineCharacteristics(self):

self.addOutput(OutputRaster(self.OUTPUT, self.tr('Interpolated IDW')))

def name(self):
return 'gridinvdist'

def displayName(self):
return self.tr('Grid (Inverse distance to a power)')

def group(self):
return self.tr('Raster analysis')

def getConsoleCommands(self):
arguments = ['-l']
arguments.append(
Expand Down
21 changes: 11 additions & 10 deletions python/plugins/processing/algs/gdal/GridNearest.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,8 @@ class GridNearest(GdalAlgorithm):
def icon(self):
return QIcon(os.path.join(pluginPath, 'images', 'gdaltools', 'grid.png'))

def name(self):
return 'gridnearestneighbor'