Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Port handling of algorithm names to QgsProcessingAlgorithm
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent dc729c1 commit 6987d7b
Show file tree
Hide file tree
Showing 232 changed files with 1,405 additions and 476 deletions.
3 changes: 3 additions & 0 deletions python/core/processing/qgsprocessingalgorithm.sip
Expand Up @@ -8,6 +8,9 @@ class QgsProcessingAlgorithm

QgsProcessingAlgorithm();
virtual ~QgsProcessingAlgorithm();

virtual QString name() const = 0;
virtual QString displayName() const = 0;
virtual QStringList tags() const;
virtual QIcon icon() const;
virtual QString svgIconPath() const;
Expand Down
Expand Up @@ -54,6 +54,14 @@ 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')

Expand All @@ -62,9 +70,6 @@ def defineCharacteristics(self):
with some other properties.
"""

# The name that the user will see in the toolbox
self.name, self.i18n_name = self.trAlgorithm('Create copy of layer')

# We add the input vector layer. It can have any kind of geometry
# It is a mandatory (not optional) one, hence the False argument
self.addParameter(ParameterVector(self.INPUT_LAYER,
Expand Down
8 changes: 6 additions & 2 deletions python/plugins/processing/algs/gdal/AssignProjection.py
Expand Up @@ -46,15 +46,19 @@ class AssignProjection(GdalAlgorithm):
CRS = 'CRS'
OUTPUT = 'OUTPUT'

def name(self):
return 'Assign projection'

def displayName(self):
return self.tr('Assign projection')

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

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Assign projection')

self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterCrs(self.CRS,
self.tr('Desired CRS'), ''))
Expand Down
8 changes: 6 additions & 2 deletions python/plugins/processing/algs/gdal/ClipByExtent.py
Expand Up @@ -53,15 +53,19 @@ class ClipByExtent(GdalAlgorithm):
RTYPE = 'RTYPE'
TYPE = ['Byte', 'Int16', 'UInt16', 'UInt32', 'Int32', 'Float32', 'Float64']

def name(self):
return 'Clip raster by extent'

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):
self.name, self.i18n_name = self.trAlgorithm('Clip raster by extent')

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 Down
8 changes: 6 additions & 2 deletions python/plugins/processing/algs/gdal/ClipByMask.py
Expand Up @@ -62,15 +62,19 @@ class ClipByMask(GdalAlgorithm):
RTYPE = 'RTYPE'
TYPE = ['Byte', 'Int16', 'UInt16', 'UInt32', 'Int32', 'Float32', 'Float64']

def name(self):
return 'Clip raster by mask layer'

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):
self.name, self.i18n_name = self.trAlgorithm('Clip raster by mask layer')

self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterVector(self.MASK, self.tr('Mask layer'),
[dataobjects.TYPE_VECTOR_POLYGON]))
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/ColorRelief.py
Expand Up @@ -47,11 +47,16 @@ class ColorRelief(GdalAlgorithm):

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

def name(self):
return 'Color relief'

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

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Color relief')
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer')))
self.addParameter(ParameterNumber(
self.BAND, self.tr('Band number'), 1, 99, 1))
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/GridAverage.py
Expand Up @@ -56,6 +56,12 @@ class GridAverage(GdalAlgorithm):

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

def name(self):
return 'Grid (Moving average)'

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

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

Expand All @@ -66,7 +72,6 @@ def group(self):
return self.tr('Raster analysis')

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Grid (Moving average)')
self.addParameter(ParameterVector(self.INPUT,
self.tr('Input layer'), [dataobjects.TYPE_VECTOR_POINT]))
self.addParameter(ParameterTableField(self.Z_FIELD,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/GridDataMetrics.py
Expand Up @@ -61,6 +61,12 @@ class GridDataMetrics(GdalAlgorithm):
DATA_METRICS = ['Minimum', 'Maximum', 'Range', 'Count', 'Average distance',
'Average distance between points']

def name(self):
return 'Grid (Data metrics)'

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

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

Expand All @@ -71,7 +77,6 @@ def group(self):
return self.tr('Raster analysis')

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Grid (Data metrics)')
self.addParameter(ParameterVector(self.INPUT,
self.tr('Input layer'), [dataobjects.TYPE_VECTOR_POINT]))
self.addParameter(ParameterTableField(self.Z_FIELD,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/GridInvDist.py
Expand Up @@ -66,11 +66,16 @@ def icon(self):
def commandLineName(self):
return "gdal:gridinvdist"

def name(self):
return 'Grid (Inverse distance to a power)'

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

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Grid (Inverse distance to a power)')
self.addParameter(ParameterVector(self.INPUT,
self.tr('Input layer'), [dataobjects.TYPE_VECTOR_POINT]))
self.addParameter(ParameterTableField(self.Z_FIELD,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/GridNearest.py
Expand Up @@ -62,11 +62,16 @@ def icon(self):
def commandLineName(self):
return "gdal:gridnearestneighbor"

def name(self):
return 'Grid (Nearest neighbor)'

def displayName(self):
return self.tr('Grid (Nearest neighbor)')

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Grid (Nearest neighbor)')
self.addParameter(ParameterVector(self.INPUT,
self.tr('Input layer'), [dataobjects.TYPE_VECTOR_POINT]))
self.addParameter(ParameterTableField(self.Z_FIELD,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/aspect.py
Expand Up @@ -48,11 +48,16 @@ class aspect(GdalAlgorithm):
ZERO_FLAT = 'ZERO_FLAT'
OUTPUT = 'OUTPUT'

def name(self):
return 'Aspect'

def displayName(self):
return self.tr('Aspect')

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Aspect')
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer')))
self.addParameter(ParameterNumber(
self.BAND, self.tr('Band number'), 1, 99, 1))
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/buildvrt.py
Expand Up @@ -51,14 +51,19 @@ class buildvrt(GdalAlgorithm):

RESOLUTION_OPTIONS = ['average', 'highest', 'lowest']

def name(self):
return 'Build Virtual Raster'

def displayName(self):
return self.tr('Build Virtual Raster')

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

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Build Virtual Raster')
self.addParameter(ParameterMultipleInput(self.INPUT,
self.tr('Input layers'), dataobjects.TYPE_RASTER))
self.addParameter(ParameterSelection(self.RESOLUTION,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/contour.py
Expand Up @@ -51,14 +51,19 @@ class contour(GdalAlgorithm):
FIELD_NAME = 'FIELD_NAME'
EXTRA = 'EXTRA'

def name(self):
return 'Contour'

def displayName(self):
return self.tr('Contour')

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

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Contour')
self.addParameter(ParameterRaster(self.INPUT_RASTER,
self.tr('Input layer'), False))
self.addParameter(ParameterNumber(self.INTERVAL,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/extractprojection.py
Expand Up @@ -44,14 +44,19 @@ class ExtractProjection(GdalAlgorithm):
INPUT = 'INPUT'
PRJ_FILE = 'PRJ_FILE'

def name(self):
return 'Extract projection'

def displayName(self):
return self.tr('Extract projection')

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

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Extract projection')
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input file')))
self.addParameter(ParameterBoolean(self.PRJ_FILE,
self.tr('Create also .prj file'), False))
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/fillnodata.py
Expand Up @@ -52,11 +52,16 @@ class fillnodata(GdalAlgorithm):
NO_DEFAULT_MASK = 'NO_DEFAULT_MASK'
OUTPUT = 'OUTPUT'

def name(self):
return 'Fill nodata'

def displayName(self):
return self.tr('Fill nodata')

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Fill nodata')
self.addParameter(ParameterRaster(
self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterNumber(self.DISTANCE,
Expand Down
8 changes: 6 additions & 2 deletions python/plugins/processing/algs/gdal/gdal2tiles.py
Expand Up @@ -63,12 +63,16 @@ class gdal2tiles(GdalAlgorithm):
def commandLineName(self):
return "gdal:gdal2tiles"

def name(self):
return 'gdal2tiles'

def displayName(self):
return self.tr('gdal2tiles')

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('gdal2tiles')

# Required parameters
self.addParameter(ParameterRaster(self.INPUT, self.tr('Input layer')))

Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/gdal2xyz.py
Expand Up @@ -43,11 +43,16 @@ class gdal2xyz(GdalAlgorithm):
BAND = 'BAND'
OUTPUT = 'OUTPUT'

def name(self):
return 'gdal2xyz'

def displayName(self):
return self.tr('gdal2xyz')

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('gdal2xyz')
self.addParameter(ParameterRaster(
self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterNumber(self.BAND,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/gdaladdo.py
Expand Up @@ -69,11 +69,16 @@ def icon(self):
def commandLineName(self):
return "gdal:overviews"

def name(self):
return 'Build overviews (pyramids)'

def displayName(self):
return self.tr('Build overviews (pyramids)')

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Build overviews (pyramids)')
self.addParameter(ParameterRaster(
self.INPUT, self.tr('Input layer'), False))
self.addParameter(ParameterString(self.LEVELS,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/gdalcalc.py
Expand Up @@ -59,11 +59,16 @@ class gdalcalc(GdalAlgorithm):
TYPE = ['Byte', 'Int16', 'UInt16', 'UInt32', 'Int32', 'Float32', 'Float64']
#DEBUG = 'DEBUG'

def name(self):
return 'Raster calculator'

def displayName(self):
return self.tr('Raster calculator')

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Raster calculator')
self.addParameter(ParameterRaster(
self.INPUT_A, self.tr('Input layer A'), False))
self.addParameter(ParameterString(self.BAND_A,
Expand Down
7 changes: 6 additions & 1 deletion python/plugins/processing/algs/gdal/gdaltindex.py
Expand Up @@ -48,14 +48,19 @@ class gdaltindex(GdalAlgorithm):
FIELD_NAME = 'FIELD_NAME'
PROJ_DIFFERENCE = 'PROJ_DIFFERENCE'

def name(self):
return 'Tile Index'

def displayName(self):
return self.tr('Tile Index')

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

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

def defineCharacteristics(self):
self.name, self.i18n_name = self.trAlgorithm('Tile Index')
self.addParameter(ParameterMultipleInput(self.INPUT,
self.tr('Input layers'), dataobjects.TYPE_RASTER))
self.addParameter(ParameterString(self.FIELD_NAME,
Expand Down

0 comments on commit 6987d7b

Please sign in to comment.