def defineCharacteristics(self):
self.name = 'Random points in extent'
self.group = 'Vector creation tools'
self.addParameter(ParameterExtent(self.EXTENT, 'Input extent'))
self.addParameter(
ParameterNumber(self.POINT_NUMBER, 'Points number', 1, 9999999, 1))
self.addParameter(
ParameterNumber(self.MIN_DISTANCE, 'Minimum distance', 0.0,
9999999, 0.0))
self.addOutput(OutputVector(self.OUTPUT, 'Random points'))
def defineCharacteristics(self):
self.name = 'Create Species Richness grid'
self.cmdName = 'richnessgrid'
self.group = 'Data Preperation'
self.addParameter(ParameterVector(self.VECTOR, 'Species localities',[ParameterVector.VECTOR_TYPE_POINT],False)) # Allow point and polygons #,/ranges ParameterVector.VECTOR_TYPE_POLYGON
self.addParameter(ParameterTableField(CreateRichnessGrid.SPEC_COL, "Species Name", CreateRichnessGrid.VECTOR))
self.addParameter(ParameterSelection(self.METHOD, "What to calculate", self.m, 0))
self.addParameter(ParameterNumber(self.GRAIN_SIZE, 'Grain size (Projection dependent)',1.0,None,100.0))
self.addParameter(ParameterExtent(self.EXTENT, 'Extent of the new Grid'))
self.addOutput(OutputRaster(self.GRID,'Richness Grid'))
def defineCharacteristics(self):
'''Here we define the inputs and output of the algorithm, along
with some other properties'''
self.name = "Random uniform"
self.cmdName = "nlmpy:randomuniform"
self.group = "Neutral landscape model (NLMpy)"
self.addParameter(ParameterExtent(self.EXTENT, "Output extent",True))
self.addParameter(ParameterRaster(self.MASK, "Mask (optional)", True))
self.addOutput(OutputRaster(self.OUTPUT_RASTER, "Result output"))
self.addParameter(ParameterNumber(self.CS, "Output Cellsize", 10, None, 1))
def testParameterExtent(self):
param = ParameterExtent('name', 'desc')
assert not param.setValue('0,2,0')
assert not param.setValue('0,2,0,a')
assert not param.setValue('0,2,2,4')
assert param.value == '0,2,2,4'
assert param.setValue(None)
assert param.value == param.default
s = param.serialize()
param2 = ParameterExtent()
param2.deserialize(s)
assert param.default == param2.default
assert param.description == param2.description
assert param.name == param2.name
def defineCharacteristics(self):
'''Here we define the inputs and output of the algorithm, along
with some other properties'''
self.name = "Midpoint displacement"
self.cmdName = "nlmpy:mpd"
self.group = "Neutral landscape model (NLMpy)"
self.addParameter(ParameterExtent(self.EXTENT, "Output extent",True))
self.addParameter(ParameterNumber(self.SCOR, "Level of Spatial Autocorrelation (0 - 1)", False, True,0.5))
self.addParameter(ParameterRaster(self.MASK, "Mask (optional)", True))
self.addOutput(OutputRaster(self.OUTPUT_RASTER, "Result output"))
self.addParameter(ParameterNumber(self.CS, "Output Cellsize", 10, None, 1))
def defineCharacteristics(self):
self.name = 'Clip raster by extent'
self.group = '[GDAL] Extraction'
self.addParameter(ParameterRaster(self.INPUT, 'Input layer', False))
self.addParameter(
ParameterString(
self.NO_DATA,
'Nodata value, leave as none to take the nodata value from input',
'none'))
self.addParameter(ParameterExtent(self.PROJWIN, 'Clipping extent'))
self.addParameter(
ParameterString(self.EXTRA, 'Additional creation parameters', ''))
self.addOutput(OutputRaster(self.OUTPUT, 'Output layer'))
def defineCharacteristics(self):
self.name = "Translate (convert format)"
self.group = "[GDAL] Conversion"
self.addParameter(ParameterRaster(translate.INPUT, "Input layer", False))
self.addParameter(ParameterNumber(translate.OUTSIZE, "Set the size of the output file (In pixels or %)", 1, None, 100))
self.addParameter(ParameterBoolean(translate.OUTSIZE_PERC, "Output size is a percentage of input size", True))
self.addParameter(ParameterString(translate.NO_DATA, "Nodata value, leave as none to take the nodata value from input", "none"))
self.addParameter(ParameterSelection(translate.EXPAND, "Expand", ["none","gray","rgb","rgba"]))
self.addParameter(ParameterCrs(translate.SRS, "Override the projection for the output file", None))
self.addParameter(ParameterExtent(translate.PROJWIN, "Subset based on georeferenced coordinates"))
self.addParameter(ParameterBoolean(translate.SDS, "Copy all subdatasets of this file to individual output files", False))
self.addParameter(ParameterString(translate.EXTRA, "Additional creation parameters", ""))
self.addOutput(OutputRaster(translate.OUTPUT, "Output layer"))
def defineCharacteristics(self):
'''Here we define the inputs and output of the algorithm, along
with some other properties'''
self.name = "Random cluster Nearest-neighbour"
self.cmdName = "nlmpy:randomclunn"
self.group = "Neutral landscape model (NLMpy)"
self.addParameter(ParameterExtent(self.EXTENT, "Output extent",True))
self.addParameter(ParameterNumber(self.NCLU, "Proportions of elements to form cluster ( 0 - 1 )",False, True,0.5))
self.addParameter(ParameterSelection(self.NEIG, "Neighbourhood structure", self.w, 0))
self.addParameter(ParameterRaster(self.MASK, "Mask (optional)", True))
self.addOutput(OutputRaster(self.OUTPUT_RASTER, "Result output"))
self.addParameter(ParameterNumber(self.CS, "Output Cellsize", 10, None, 1))
def defineCharacteristics(self):
self.name = "nviz"
self.group = "Visualization(NVIZ)"
self.addParameter(
ParameterMultipleInput(nviz.ELEVATION, "Elevation layers",
ParameterMultipleInput.TYPE_RASTER, True))
self.addParameter(
ParameterMultipleInput(nviz.VECTOR, "Vector layers",
ParameterMultipleInput.TYPE_VECTOR_ANY,
True))
self.addParameter(
ParameterExtent(nviz.GRASS_REGION_EXTENT_PARAMETER,
"GRASS region extent"))
self.addParameter(
ParameterNumber(self.GRASS_REGION_CELLSIZE_PARAMETER,
"GRASS region cellsize (leave 0 for default)", 0,
None, 0.0))
def defineCharacteristics(self):
self.name = 'Create Species Richness grid'
self.cmdName = 'richnessgrid'
self.group = 'Data Manipulation'
self.addParameter(
ParameterVector(self.VECTOR, 'Species localities',
[ParameterVector.VECTOR_TYPE_POINT], False)
) # Allow point and later polygons ,ParameterVector.VECTOR_TYPE_POLYGON
self.addParameter(
ParameterTableField(CreateRichnessGrid.SPEC_COL, "Species Name",
CreateRichnessGrid.VECTOR))
self.addParameter(
ParameterNumber(self.GRAIN_SIZE, 'Grain size', 1, None, 100))
self.addParameter(
ParameterExtent(self.EXTENT, 'Extent of the new Grid'))
self.addOutput(OutputRaster(self.GRID, 'Richness Grid'))
def defineCharacteristicsFromFile(self):
lines = open(self.descriptionFile)
line = lines.readline().strip('\n').strip()
self.appkey = line
line = lines.readline().strip('\n').strip()
self.cliName = line
line = lines.readline().strip('\n').strip()
self.name = line
line = lines.readline().strip('\n').strip()
self.group = line
while line != '':
try:
line = line.strip('\n').strip()
if line.startswith('Parameter'):
param = ParameterFactory.getFromString(line)
# Hack for initializing the elevation parameters
# from Processing configuration
if param.name == '-elev.dem.path' or param.name \
== '-elev.dem':
param.default = OTBUtils.otbSRTMPath()
elif param.name == '-elev.dem.geoid' or param.name \
== '-elev.geoid':
param.default = OTBUtils.otbGeoidPath()
self.addParameter(param)
elif line.startswith('*Parameter'):
param = ParameterFactory.getFromString(line[1:])
param.isAdvanced = True
self.addParameter(param)
elif line.startswith('Extent'):
self.addParameter(ParameterExtent(self.REGION_OF_INTEREST,
'Region of interest', '0,1,0,1'))
self.hasROI = True
else:
self.addOutput(OutputFactory.getFromString(line))
line = lines.readline().strip('\n').strip()
except Exception, e:
ProcessingLog.addToLog(ProcessingLog.LOG_ERROR,
'Could not open OTB algorithm: '
+ self.descriptionFile + '\n' + line)
raise e
def defineCharacteristics(self):
self.name = 'nviz'
self.group = 'Visualization(NVIZ)'
self.addParameter(
ParameterMultipleInput(nviz.ELEVATION,
'Raster file(s) for elevation',
ParameterMultipleInput.TYPE_RASTER, True))
self.addParameter(
ParameterMultipleInput(nviz.VECTOR,
'Vector lines/areas overlay file(s)',
ParameterMultipleInput.TYPE_VECTOR_ANY,
True))
self.addParameter(
ParameterMultipleInput(nviz.COLOR, 'Raster file(s) for color',
ParameterMultipleInput.TYPE_RASTER, True))
self.addParameter(
ParameterExtent(nviz.GRASS_REGION_EXTENT_PARAMETER,
'GRASS region extent'))
self.addParameter(
ParameterNumber(self.GRASS_REGION_CELLSIZE_PARAMETER,
'GRASS region cellsize (leave 0 for default)', 0,
None, 0.0))
def defineCharacteristicsFromFile(self):
lines = open(self.descriptionFile)
line = lines.readline().strip("\n").strip()
self.appkey = line
line = lines.readline().strip("\n").strip()
self.cliName = line
line = lines.readline().strip("\n").strip()
self.name = line
line = lines.readline().strip("\n").strip()
self.group = line
while line != "":
try:
line = line.strip("\n").strip()
if line.startswith("Parameter"):
param = ParameterFactory.getFromString(line)
# Hack for initializing the elevation parameters from Processing configuration
if param.name == "-elev.dem.path" or param.name == "-elev.dem":
param.default = OTBUtils.otbSRTMPath()
elif param.name == "-elev.dem.geoid" or param.name == "-elev.geoid":
param.default = OTBUtils.otbGeoidPath()
self.addParameter(param)
elif line.startswith("*Parameter"):
param = ParameterFactory.getFromString(line[1:])
param.isAdvanced = True
self.addParameter(param)
elif line.startswith("Extent"):
self.addParameter(
ParameterExtent(self.REGION_OF_INTEREST,
"Region of interest", "0,1,0,1"))
self.hasROI = True
else:
self.addOutput(OutputFactory.getFromString(line))
line = lines.readline().strip("\n").strip()
except Exception, e:
ProcessingLog.addToLog(
ProcessingLog.LOG_ERROR, "Could not open OTB algorithm: " +
self.descriptionFile + "\n" + line)
raise e
def defineCharacteristics(self):
self.name = 'Translate (convert format)'
self.group = '[GDAL] Conversion'
self.addParameter(ParameterRaster(self.INPUT, 'Input layer', False))
self.addParameter(
ParameterNumber(
self.OUTSIZE,
'Set the size of the output file (In pixels or %)', 1, None,
100))
self.addParameter(
ParameterBoolean(self.OUTSIZE_PERC,
'Output size is a percentage of input size',
True))
self.addParameter(
ParameterString(
self.NO_DATA,
'Nodata value, leave as none to take the nodata value from input',
'none'))
self.addParameter(
ParameterSelection(self.EXPAND, 'Expand',
['none', 'gray', 'rgb', 'rgba']))
self.addParameter(
ParameterCrs(self.SRS,
'Override the projection for the output file', None))
self.addParameter(
ParameterExtent(self.PROJWIN,
'Subset based on georeferenced coordinates'))
self.addParameter(
ParameterBoolean(
self.SDS,
'Copy all subdatasets of this file to individual output files',
False))
self.addParameter(
ParameterString(self.EXTRA,
'Additional creation parameters',
'',
optional=True))
self.addOutput(OutputRaster(self.OUTPUT, 'Output layer'))
class GrassAlgorithm(GeoAlgorithm):
GRASS_OUTPUT_TYPE_PARAMETER = "GRASS_OUTPUT_TYPE_PARAMETER"
GRASS_MIN_AREA_PARAMETER = "GRASS_MIN_AREA_PARAMETER"
GRASS_SNAP_TOLERANCE_PARAMETER = "GRASS_SNAP_TOLERANCE_PARAMETER"
GRASS_REGION_EXTENT_PARAMETER = "GRASS_REGION_PARAMETER"
GRASS_REGION_CELLSIZE_PARAMETER = "GRASS_REGION_CELLSIZE_PARAMETER"
GRASS_REGION_ALIGN_TO_RESOLUTION = "-a_r.region"
OUTPUT_TYPES = ["auto", "point", "line", "area"]
def __init__(self, descriptionfile):
GeoAlgorithm.__init__(self)
self.descriptionFile = descriptionfile
self.defineCharacteristicsFromFile()
self.numExportedLayers = 0
#GRASS console output, needed to do postprocessing in case GRASS dumps results to the console
self.consoleOutput = []
def getCopy(self):
newone = GrassAlgorithm(self.descriptionFile)
newone.provider = self.provider
return newone
def getIcon(self):
return QIcon(os.path.dirname(__file__) + "/../images/grass.png")
def helpFile(self):
return 'http://grass.osgeo.org/grass64/manuals/' + self.grassName + ".html"
def getParameterDescriptions(self):
descs = {}
try:
helpfile = self.helpFile()
except WrongHelpFileException:
return descs
if helpfile:
try:
infile = open(helpfile)
lines = infile.readlines()
for i in range(len(lines)):
if lines[i].startswith("<DT><b>"):
for param in self. parameters:
searchLine = "<b>" + param.name + "</b>"
if searchLine in lines[i]:
i+=1
descs[param.name] = lines[i][4:-6]
break
infile.close()
except Exception:
pass
return descs
def defineCharacteristicsFromFile(self):
lines = open(self.descriptionFile)
line = lines.readline().strip("\n").strip()
self.grassName = line
line = lines.readline().strip("\n").strip()
self.name = line
line = lines.readline().strip("\n").strip()
self.group = line
hasRasterOutput = False
hasVectorInput = False
vectorOutputs = 0
while line != "":
try:
line = line.strip("\n").strip()
if line.startswith("Parameter"):
parameter = ParameterFactory.getFromString(line);
self.addParameter(parameter)
if isinstance(parameter, ParameterVector):
hasVectorInput = True
if isinstance(parameter, ParameterMultipleInput) and parameter.datatype < 3:
hasVectorInput = True
elif line.startswith("*Parameter"):
param = ParameterFactory.getFromString(line[1:])
param.isAdvanced = True
self.addParameter(param)
else:
output = OutputFactory.getFromString(line)
self.addOutput(output);
if isinstance(output, OutputRaster):
hasRasterOutput = True
elif isinstance(output, OutputVector):
vectorOutputs += 1
line = lines.readline().strip("\n").strip()
except Exception,e:
ProcessingLog.addToLog(ProcessingLog.LOG_ERROR, "Could not open GRASS algorithm: " + self.descriptionFile + "\n" + line)
raise e
lines.close()
self.addParameter(ParameterExtent(self.GRASS_REGION_EXTENT_PARAMETER, "GRASS region extent"))
if hasRasterOutput:
self.addParameter(ParameterNumber(self.GRASS_REGION_CELLSIZE_PARAMETER, "GRASS region cellsize (leave 0 for default)", 0, None, 0.0))
if hasVectorInput:
param = ParameterNumber(self.GRASS_SNAP_TOLERANCE_PARAMETER, "v.in.ogr snap tolerance (-1 = no snap)", -1, None, -1.0)
param.isAdvanced = True
self.addParameter(param)
param = ParameterNumber(self.GRASS_MIN_AREA_PARAMETER, "v.in.ogr min area", 0, None, 0.0001)
param.isAdvanced = True
self.addParameter(param)
if vectorOutputs == 1:
param = ParameterSelection(self.GRASS_OUTPUT_TYPE_PARAMETER, "v.out.ogr output type", self.OUTPUT_TYPES)
param.isAdvanced = True
self.addParameter(param)
def processParameterLine(self, line):
param = None
out = None
line = line.replace('#', '')
# If the line is in the format of the text description files for
# normal algorithms, then process it using parameter and output
# factories
if '|' in line:
self.processDescriptionParameterLine(line)
return
if line == "nomodeler":
self.showInModeler = False
tokens = line.split('=', 1)
desc = self.createDescriptiveName(tokens[0])
if tokens[1].lower().strip() == 'group':
self.group = tokens[0]
return
if tokens[1].lower().strip() == 'name':
self.name = tokens[0]
return
if tokens[1].lower().strip() == 'raster':
param = ParameterRaster(tokens[0], desc, False)
elif tokens[1].lower().strip() == 'vector':
param = ParameterVector(tokens[0], desc,
[ParameterVector.VECTOR_TYPE_ANY])
elif tokens[1].lower().strip() == 'vector point':
param = ParameterVector(tokens[0], desc,
[ParameterVector.VECTOR_TYPE_POINT])
elif tokens[1].lower().strip() == 'vector line':
param = ParameterVector(tokens[0], desc,
[ParameterVector.VECTOR_TYPE_LINE])
elif tokens[1].lower().strip() == 'vector polygon':
param = ParameterVector(tokens[0], desc,
[ParameterVector.VECTOR_TYPE_POLYGON])
elif tokens[1].lower().strip() == 'table':
param = ParameterTable(tokens[0], desc, False)
elif tokens[1].lower().strip() == 'multiple raster':
param = ParameterMultipleInput(tokens[0], desc,
ParameterMultipleInput.TYPE_RASTER)
param.optional = False
elif tokens[1].lower().strip() == 'multiple vector':
param = ParameterMultipleInput(
tokens[0], desc, ParameterMultipleInput.TYPE_VECTOR_ANY)
param.optional = False
elif tokens[1].lower().strip().startswith('selection'):
options = tokens[1].strip()[len('selection '):].split(';')
param = ParameterSelection(tokens[0], desc, options)
elif tokens[1].lower().strip().startswith('boolean'):
default = tokens[1].strip()[len('boolean') + 1:]
param = ParameterBoolean(tokens[0], desc, default)
elif tokens[1].lower().strip() == 'extent':
param = ParameterExtent(tokens[0], desc)
elif tokens[1].lower().strip() == 'file':
param = ParameterFile(tokens[0], desc, False)
elif tokens[1].lower().strip() == 'folder':
param = ParameterFile(tokens[0], desc, True)
elif tokens[1].lower().strip().startswith('number'):
default = tokens[1].strip()[len('number') + 1:]
param = ParameterNumber(tokens[0], desc, default=default)
elif tokens[1].lower().strip().startswith('field'):
field = tokens[1].strip()[len('field') + 1:]
found = False
for p in self.parameters:
if p.name == field:
found = True
break
if found:
param = ParameterTableField(tokens[0], desc, field)
elif tokens[1].lower().strip().startswith('string'):
default = tokens[1].strip()[len('string') + 1:]
param = ParameterString(tokens[0], desc, default)
elif tokens[1].lower().strip().startswith('longstring'):
default = tokens[1].strip()[len('longstring') + 1:]
param = ParameterString(tokens[0], desc, default, multiline=True)
elif tokens[1].lower().strip().startswith('crs'):
default = tokens[1].strip()[len('crs') + 1:]
if not default:
default = 'EPSG:4326'
param = ParameterCrs(tokens[0], desc, default)
elif tokens[1].lower().strip().startswith('output raster'):
out = OutputRaster()
elif tokens[1].lower().strip().startswith('output vector'):
out = OutputVector()
elif tokens[1].lower().strip().startswith('output table'):
out = OutputTable()
elif tokens[1].lower().strip().startswith('output html'):
out = OutputHTML()
elif tokens[1].lower().strip().startswith('output file'):
out = OutputFile()
subtokens = tokens[1].split(' ')
if len(subtokens > 2):
out.ext = subtokens[2]
elif tokens[1].lower().strip().startswith('output directory'):
out = OutputDirectory()
elif tokens[1].lower().strip().startswith('output number'):
out = OutputNumber()
elif tokens[1].lower().strip().startswith('output string'):
out = OutputString()
if param is not None:
self.addParameter(param)
elif out is not None:
out.name = tokens[0]
out.description = desc
self.addOutput(out)
else:
raise WrongScriptException(
'Could not load script:' + self.descriptionFile
or '' + '.\n Problem with line "' + line + '"')
def defineCharacteristics(self):
self.name = "lasquery"
self.group = "LAStools"
self.addParametersVerboseGUI()
self.addParameter(ParameterExtent(self.AOI, 'area of interest'))
class Grass7Algorithm(GeoAlgorithm):
GRASS_OUTPUT_TYPE_PARAMETER = 'GRASS_OUTPUT_TYPE_PARAMETER'
GRASS_MIN_AREA_PARAMETER = 'GRASS_MIN_AREA_PARAMETER'
GRASS_SNAP_TOLERANCE_PARAMETER = 'GRASS_SNAP_TOLERANCE_PARAMETER'
GRASS_REGION_EXTENT_PARAMETER = 'GRASS_REGION_PARAMETER'
GRASS_REGION_CELLSIZE_PARAMETER = 'GRASS_REGION_CELLSIZE_PARAMETER'
GRASS_REGION_ALIGN_TO_RESOLUTION = '-a_r.region'
OUTPUT_TYPES = ['auto', 'point', 'line', 'area']
def __init__(self, descriptionfile):
GeoAlgorithm.__init__(self)
self.descriptionFile = descriptionfile
self.defineCharacteristicsFromFile()
self.numExportedLayers = 0
# GRASS GIS 7 console output, needed to do postprocessing in case GRASS
# dumps results to the console
self.consoleOutput = []
def getCopy(self):
newone = Grass7Algorithm(self.descriptionFile)
newone.provider = self.provider
return newone
def getIcon(self):
return QIcon(os.path.dirname(__file__) + '/../../images/grass.png')
def help(self):
return False, 'http://grass.osgeo.org/grass70/manuals/' + self.grassName \
+ '.html'
def getParameterDescriptions(self):
descs = {}
try:
helpfile = self.helpFile()
except WrongHelpFileException:
return descs
if helpfile:
try:
infile = open(helpfile)
lines = infile.readlines()
for i in range(len(lines)):
if lines[i].startswith('<DT><b>'):
for param in self.parameters:
searchLine = '<b>' + param.name + '</b>'
if searchLine in lines[i]:
i += 1
descs[param.name] = (lines[i])[4:-6]
break
infile.close()
except Exception:
pass
return descs
def defineCharacteristicsFromFile(self):
lines = open(self.descriptionFile)
line = lines.readline().strip('\n').strip()
self.grassName = line
line = lines.readline().strip('\n').strip()
self.name = line
line = lines.readline().strip('\n').strip()
self.group = line
hasRasterOutput = False
hasVectorInput = False
vectorOutputs = 0
while line != '':
try:
line = line.strip('\n').strip()
if line.startswith('Parameter'):
parameter = ParameterFactory.getFromString(line)
self.addParameter(parameter)
if isinstance(parameter, ParameterVector):
hasVectorInput = True
if isinstance(parameter, ParameterMultipleInput) \
and parameter.datatype < 3:
hasVectorInput = True
elif line.startswith('*Parameter'):
param = ParameterFactory.getFromString(line[1:])
param.isAdvanced = True
self.addParameter(param)
else:
output = OutputFactory.getFromString(line)
self.addOutput(output)
if isinstance(output, OutputRaster):
hasRasterOutput = True
elif isinstance(output, OutputVector):
vectorOutputs += 1
line = lines.readline().strip('\n').strip()
except Exception, e:
ProcessingLog.addToLog(
ProcessingLog.LOG_ERROR,
'Could not open GRASS GIS 7 algorithm: ' +
self.descriptionFile + '\n' + line)
raise e
lines.close()
self.addParameter(
ParameterExtent(self.GRASS_REGION_EXTENT_PARAMETER,
'GRASS GIS 7 region extent'))
if hasRasterOutput:
self.addParameter(
ParameterNumber(
self.GRASS_REGION_CELLSIZE_PARAMETER,
'GRASS GIS 7 region cellsize (leave 0 for default)', 0,
None, 0.0))
if hasVectorInput:
param = ParameterNumber(self.GRASS_SNAP_TOLERANCE_PARAMETER,
'v.in.ogr snap tolerance (-1 = no snap)',
-1, None, -1.0)
param.isAdvanced = True
self.addParameter(param)
param = ParameterNumber(self.GRASS_MIN_AREA_PARAMETER,
'v.in.ogr min area', 0, None, 0.0001)
param.isAdvanced = True
self.addParameter(param)
if vectorOutputs == 1:
param = ParameterSelection(self.GRASS_OUTPUT_TYPE_PARAMETER,
'v.out.ogr output type',
self.OUTPUT_TYPES)
param.isAdvanced = True
self.addParameter(param)
def processParameterLine(self, line):
param = None
out = None
line = line.replace("#", "")
# If the line is in the format of the text description files for normal algorithms,
# then process it using parameter and output factories
if '|' in line:
self.processDescriptionParameterLine(line)
return
tokens = line.split("=")
desc = self.createDescriptiveName(tokens[0])
if tokens[1].lower().strip() == "group":
self.group = tokens[0]
return
if tokens[1].lower().strip() == "name":
self.name = tokens[0]
return
if tokens[1].lower().strip() == "raster":
param = ParameterRaster(tokens[0], desc, False)
elif tokens[1].lower().strip() == "vector":
param = ParameterVector(tokens[0], desc,
[ParameterVector.VECTOR_TYPE_ANY])
elif tokens[1].lower().strip() == "table":
param = ParameterTable(tokens[0], desc, False)
elif tokens[1].lower().strip() == "multiple raster":
param = ParameterMultipleInput(tokens[0], desc,
ParameterMultipleInput.TYPE_RASTER)
param.optional = False
elif tokens[1].lower().strip() == "multiple vector":
param = ParameterMultipleInput(
tokens[0], desc, ParameterMultipleInput.TYPE_VECTOR_ANY)
param.optional = False
elif tokens[1].lower().strip().startswith("selection"):
options = tokens[1].strip()[len("selection"):].split(";")
param = ParameterSelection(tokens[0], desc, options)
elif tokens[1].lower().strip().startswith("boolean"):
default = tokens[1].strip()[len("boolean") + 1:]
param = ParameterBoolean(tokens[0], desc, default)
elif tokens[1].lower().strip() == "extent":
param = ParameterExtent(tokens[0], desc)
elif tokens[1].lower().strip() == "file":
param = ParameterFile(tokens[0], desc, False)
elif tokens[1].lower().strip() == "folder":
param = ParameterFile(tokens[0], desc, True)
elif tokens[1].lower().strip().startswith("number"):
default = tokens[1].strip()[len("number") + 1:]
param = ParameterNumber(tokens[0], desc, default=default)
elif tokens[1].lower().strip().startswith("field"):
field = tokens[1].strip()[len("field") + 1:]
found = False
for p in self.parameters:
if p.name == field:
found = True
break
if found:
param = ParameterTableField(tokens[0], tokens[0], field)
elif tokens[1].lower().strip().startswith("string"):
default = tokens[1].strip()[len("string") + 1:]
param = ParameterString(tokens[0], desc, default)
elif tokens[1].lower().strip().startswith("output raster"):
out = OutputRaster()
elif tokens[1].lower().strip().startswith("output vector"):
out = OutputVector()
elif tokens[1].lower().strip().startswith("output table"):
out = OutputTable()
elif tokens[1].lower().strip().startswith("output html"):
out = OutputHTML()
elif tokens[1].lower().strip().startswith("output file"):
out = OutputFile()
elif tokens[1].lower().strip().startswith("output number"):
out = OutputNumber()
elif tokens[1].lower().strip().startswith("output string"):
out = OutputString()
if param != None:
self.addParameter(param)
elif out != None:
out.name = tokens[0]
out.description = tokens[0]
self.addOutput(out)
else:
raise WrongScriptException("Could not load script:" +
self.descriptionFile +
".\n Problem with line \"" + line +
"\"")
def processParameterLine(self, line):
param = None
out = None
line = line.replace('#', '')
if line.lower().strip().startswith('report'):
self.report = True
self.addOutput(OutputHTML(RAlgorithm.KNITR_REPORT, 'HTML Report'))
return
if line.lower().strip().startswith('showplots'):
self.showPlots = True
self.addOutput(OutputHTML(RAlgorithm.RPLOTS, 'R Plots'))
return
if line.lower().strip().startswith('dontuserasterpackage'):
self.useRasterPackage = False
return
if line.lower().strip().startswith('passfilenames'):
self.passFileNames = True
return
if line.lower().strip().startswith('shapefilespackage'):
self.useShapefilesPackage = True
return
tokens = line.split('=')
desc = self.createDescriptiveName(tokens[0])
if tokens[1].lower().strip() == 'group':
self.group = tokens[0]
return
if tokens[1].lower().strip().startswith('raster'):
param = ParameterRaster(tokens[0], desc, False)
elif tokens[1].lower().strip() == 'vector':
param = ParameterVector(tokens[0], desc,
[ParameterVector.VECTOR_TYPE_ANY])
elif tokens[1].lower().strip() == 'table':
param = ParameterTable(tokens[0], desc, False)
elif tokens[1].lower().strip().startswith('multiple raster'):
param = ParameterMultipleInput(tokens[0], desc,
ParameterMultipleInput.TYPE_RASTER)
param.optional = False
elif tokens[1].lower().strip() == 'multiple vector':
param = ParameterMultipleInput(tokens[0], desc,
ParameterMultipleInput.TYPE_VECTOR_ANY)
param.optional = False
elif tokens[1].lower().strip().startswith('selection'):
options = tokens[1].strip()[len('selection'):].split(';')
param = ParameterSelection(tokens[0], desc, options)
elif tokens[1].lower().strip().startswith('boolean'):
default = tokens[1].strip()[len('boolean') + 1:]
param = ParameterBoolean(tokens[0], desc, default)
elif tokens[1].lower().strip().startswith('number'):
try:
default = float(tokens[1].strip()[len('number') + 1:])
param = ParameterNumber(tokens[0], desc, default=default)
except:
raise WrongScriptException('Could not load R script:'
+ self.descriptionFile + '.\n Problem with line "'
+ line + '"')
elif tokens[1].lower().strip().startswith('field'):
field = tokens[1].strip()[len('field') + 1:]
found = False
for p in self.parameters:
if p.name == field:
found = True
break
if found:
param = ParameterTableField(tokens[0], desc, field)
elif tokens[1].lower().strip() == 'extent':
param = ParameterExtent(tokens[0], desc)
elif tokens[1].lower().strip() == 'file':
param = ParameterFile(tokens[0], desc, False)
elif tokens[1].lower().strip() == 'folder':
param = ParameterFile(tokens[0], desc, True)
elif tokens[1].lower().strip().startswith('string'):
default = tokens[1].strip()[len('string') + 1:]
param = ParameterString(tokens[0], desc, default)
elif tokens[1].lower().strip().startswith('output raster'):
out = OutputRaster()
elif tokens[1].lower().strip().startswith('output vector'):
out = OutputVector()
elif tokens[1].lower().strip().startswith('output table'):
out = OutputTable()
elif tokens[1].lower().strip().startswith('output file'):
out = OutputFile()
elif tokens[1].lower().strip().startswith('output string'):
out = OutputString()
self.outputStringExist = True
self.outputStringName = tokens[0]
elif tokens[1].lower().strip().startswith('output number'):
out = OutputNumber()
self.outputNumberBool = True
self.outputNumberName = tokens[0]
if param is not None:
self.addParameter(param)
elif out is not None:
out.name = tokens[0]
out.description = tokens[0]
self.addOutput(out)
else:
raise WrongScriptException('Could not load R script:'
+ self.descriptionFile
+ '.\n Problem with line "' + line + '"'
)
def okPressed(self):
description = unicode(self.nameTextBox.text())
if description.strip() == "":
QMessageBox.critical(self, "Unable to define parameter",
"Invalid parameter name")
return
if self.param is None:
validChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
safeName = ''.join(c for c in description if c in validChars)
name = self.paramType.upper().replace(" ",
"") + "_" + safeName.upper()
else:
name = self.param.name
if self.paramType == ModelerParameterDefinitionDialog.PARAMETER_BOOLEAN or isinstance(
self.param, ParameterBoolean):
self.param = ParameterBoolean(name, description,
self.yesNoCombo.currentIndex() == 0)
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_TABLE_FIELD or isinstance(
self.param, ParameterTableField):
if self.parentCombo.currentIndex() < 0:
QMessageBox.critical(self, "Unable to define parameter",
"Wrong or missing parameter values")
return
parent = self.parentCombo.itemData(self.parentCombo.currentIndex())
self.param = ParameterTableField(name, description, parent)
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_RASTER or isinstance(
self.param, ParameterRaster):
self.param = ParameterRaster(name, description,
self.yesNoCombo.currentIndex() == 1)
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_TABLE or isinstance(
self.param, ParameterTable):
self.param = ParameterTable(name, description,
self.yesNoCombo.currentIndex() == 1)
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_VECTOR or isinstance(
self.param, ParameterVector):
self.param = ParameterVector(
name, description, [self.shapetypeCombo.currentIndex() - 1],
self.yesNoCombo.currentIndex() == 1)
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_MULTIPLE or isinstance(
self.param, ParameterMultipleInput):
self.param = ParameterMultipleInput(
name, description,
self.datatypeCombo.currentIndex() - 1,
self.yesNoCombo.currentIndex() == 1)
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_NUMBER or isinstance(
self.param, ParameterNumber):
try:
vmin = str(self.minTextBox.text()).strip()
if vmin == "":
vmin = None
else:
vmin = float(vmin)
vmax = str(self.maxTextBox.text()).strip()
if vmax == "":
vmax = None
else:
vmax = float(vmax)
self.param = ParameterNumber(
name, description, vmin, vmax,
float(str(self.defaultTextBox.text())))
except:
QMessageBox.critical(self, "Unable to define parameter",
"Wrong or missing parameter values")
return
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_STRING or isinstance(
self.param, ParameterString):
self.param = ParameterString(name, description,
str(self.defaultTextBox.text()))
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_EXTENT or isinstance(
self.param, ParameterExtent):
self.param = ParameterExtent(name, description)
elif self.paramType == ModelerParameterDefinitionDialog.PARAMETER_FILE or isinstance(
self.param, ParameterFile):
isFolder = self.fileFolderCombo.currentIndex() == 1
self.param = ParameterFile(name, description, isFolder=isFolder)
self.close()
def processParameterLine(self, line):
param = None
out = None
line = line.replace("#", "")
if line.lower().strip().startswith("showplots"):
self.showPlots = True
self.addOutput(OutputHTML(RAlgorithm.RPLOTS, "R Plots"))
return
if line.lower().strip().startswith("dontuserasterpackage"):
self.useRasterPackage = False
return
if line.lower().strip().startswith("passfilenames"):
self.passFileNames = True
return
tokens = line.split("=")
desc = self.createDescriptiveName(tokens[0])
if tokens[1].lower().strip() == "group":
self.group = tokens[0]
return
if tokens[1].lower().strip().startswith("raster"):
param = ParameterRaster(tokens[0], desc, False)
elif tokens[1].lower().strip() == "vector":
param = ParameterVector(tokens[0], desc,
[ParameterVector.VECTOR_TYPE_ANY])
elif tokens[1].lower().strip() == "table":
param = ParameterTable(tokens[0], desc, False)
elif tokens[1].lower().strip().startswith("multiple raster"):
param = ParameterMultipleInput(tokens[0], desc,
ParameterMultipleInput.TYPE_RASTER)
param.optional = False
elif tokens[1].lower().strip() == "multiple vector":
param = ParameterMultipleInput(
tokens[0], desc, ParameterMultipleInput.TYPE_VECTOR_ANY)
param.optional = False
elif tokens[1].lower().strip().startswith("selection"):
options = tokens[1].strip()[len("selection"):].split(";")
param = ParameterSelection(tokens[0], desc, options)
elif tokens[1].lower().strip().startswith("boolean"):
default = tokens[1].strip()[len("boolean") + 1:]
param = ParameterBoolean(tokens[0], desc, default)
elif tokens[1].lower().strip().startswith("number"):
try:
default = float(tokens[1].strip()[len("number") + 1:])
param = ParameterNumber(tokens[0], desc, default=default)
except:
raise WrongScriptException("Could not load R script:" +
self.descriptionFile +
".\n Problem with line \"" + line +
"\"")
elif tokens[1].lower().strip().startswith("field"):
field = tokens[1].strip()[len("field") + 1:]
found = False
for p in self.parameters:
if p.name == field:
found = True
break
if found:
param = ParameterTableField(tokens[0], tokens[0], field)
elif tokens[1].lower().strip() == "extent":
param = ParameterExtent(tokens[0], desc)
elif tokens[1].lower().strip() == "file":
param = ParameterFile(tokens[0], desc, False)
elif tokens[1].lower().strip() == "folder":
param = ParameterFile(tokens[0], desc, True)
elif tokens[1].lower().strip().startswith("string"):
default = tokens[1].strip()[len("string") + 1:]
param = ParameterString(tokens[0], desc, default)
elif tokens[1].lower().strip().startswith("output raster"):
out = OutputRaster()
elif tokens[1].lower().strip().startswith("output vector"):
out = OutputVector()
elif tokens[1].lower().strip().startswith("output table"):
out = OutputTable()
elif tokens[1].lower().strip().startswith("output file"):
out = OutputFile()
if param != None:
self.addParameter(param)
elif out != None:
out.name = tokens[0]
out.description = tokens[0]
self.addOutput(out)
else:
raise WrongScriptException("Could not load R script:" +
self.descriptionFile +
".\n Problem with line \"" + line +
"\"")
class OTBAlgorithm(GeoAlgorithm):
REGION_OF_INTEREST = "ROI"
def __init__(self, descriptionfile):
GeoAlgorithm.__init__(self)
self.roiFile = None
self.descriptionFile = descriptionfile
self.defineCharacteristicsFromFile()
self.numExportedLayers = 0
self.hasROI = None
def __str__(self):
return ("Algo : " + self.name + " from app : " + self.cliName +
" in : " + self.group)
def getCopy(self):
newone = OTBAlgorithm(self.descriptionFile)
newone.provider = self.provider
return newone
def getIcon(self):
return PyQt4.QtGui.QIcon(
os.path.dirname(__file__) + "/../../images/otb.png")
def help(self):
folder = os.path.join(OTBUtils.otbDescriptionPath(), 'doc')
helpfile = os.path.join(str(folder), self.appkey + ".html")
if os.path.exists(helpfile):
return False, helpfile
else:
raise WrongHelpFileException(
"Could not find help file for this algorithm. \nIf you have it put it in: \n"
+ str(folder))
def adapt_list_to_string(self, c_list):
a_list = c_list[1:]
if a_list[0] in ["ParameterVector", "ParameterMultipleInput"]:
if c_list[0] == "ParameterType_InputImageList":
a_list[3] = 3
elif c_list[0] == "ParameterType_InputFilenameList":
a_list[3] = 4
else:
a_list[3] = -1
a_list[1] = "-%s" % a_list[1]
def mystr(par):
if type(par) == type([]):
return ";".join(par)
return str(par)
b_list = map(mystr, a_list)
res = "|".join(b_list)
return res
def get_list_from_node(self, myet):
all_params = []
for parameter in myet.iter('parameter'):
rebuild = []
par_type = parameter.find('parameter_type').text
key = parameter.find('key').text
name = parameter.find('name').text
source_par_type = parameter.find(
'parameter_type').attrib['source_parameter_type']
rebuild.append(source_par_type)
rebuild.append(par_type)
rebuild.append(key)
rebuild.append(name)
for each in parameter[4:]:
if not each.tag in ["hidden"]:
if len(list(each)) == 0:
rebuild.append(each.text)
else:
rebuild.append(
[item.text for item in each.iter('choice')])
all_params.append(rebuild)
return all_params
def defineCharacteristicsFromFile(self):
content = open(self.descriptionFile).read()
dom_model = ET.fromstring(content)
self.appkey = dom_model.find('key').text
self.cliName = dom_model.find('exec').text
self.name = dom_model.find('longname').text
self.group = dom_model.find('group').text
#ProcessingLog.addToLog(ProcessingLog.LOG_INFO, "Reading parameters for %s" % self.appkey)
rebu = None
the_result = None
try:
rebu = self.get_list_from_node(dom_model)
the_result = map(self.adapt_list_to_string, rebu)
except Exception, e:
ProcessingLog.addToLog(
ProcessingLog.LOG_ERROR, "Could not open OTB algorithm: " +
self.descriptionFile + "\n" + traceback.format_exc())
raise e
for line in the_result:
try:
if line.startswith("Parameter"):
param = ParameterFactory.getFromString(line)
# Hack for initializing the elevation parameters from Processing configuration
if param.name == "-elev.dem.path" or param.name == "-elev.dem" or "elev.dem" in param.name:
param.default = OTBUtils.otbSRTMPath()
elif param.name == "-elev.dem.geoid" or param.name == "-elev.geoid" or "elev.geoid" in param.name:
param.default = OTBUtils.otbGeoidPath()
self.addParameter(param)
elif line.startswith("*Parameter"):
param = ParameterFactory.getFromString(line[1:])
param.isAdvanced = True
self.addParameter(param)
elif line.startswith("Extent"):
self.addParameter(
ParameterExtent(self.REGION_OF_INTEREST,
"Region of interest", "0,1,0,1"))
self.hasROI = True
else:
self.addOutput(OutputFactory.getFromString(line))
except Exception, e:
ProcessingLog.addToLog(
ProcessingLog.LOG_ERROR, "Could not open OTB algorithm: " +
self.descriptionFile + "\n" + line)
raise e
