sextante源码剖析（三）之自定义算法

from qgis.core import *
from PyQt4.QtCore import *
from PyQt4.QtGui import *
from sextante.core.QGisLayers import QGisLayers
from sextante.core.SextanteVectorWriter import SextanteVectorWriter

##[Example scripts]=group
##input=vector
##output=output vector

• raster，栅格文件；
• vector，矢量文件；
• table，表单；
• number，数字，必须提供默认值，例如dept =number  2.4；
• string，字符串，必须提供默认值，例如name=string  xiluoduyu；
• boolean，布尔值，可选True或False，例如，verbose=boolean True，默认为False；
• multiple raster，栅格数据集合，即可以同时选择输入多个栅格文件；
• multiple vector，矢量数据集合，即可以同时选择输入多个矢量文件；
• field，矢量数据属性中的字段，在field后面必须跟着矢量文件名，例如若在前面有选择输入矢量文件：myLayer=vector，则可通过myfield=field myLayer来选择矢量数据中的要素；
• folder，文件夹；
• file，文件名。

def createDescriptiveName(self, s):
        return s.replace("_", " ")

#首先获取输入的矢量文件。输入的文件input只是文件对应的路径，
#因而需要通过Sextante.getObjectFromUri()将input转换为QGIS矢量图层对象.
#实际上Sextante.getObjectFromUri()只是简单调用了QGisLayers.getObjectFromUri(input)而已。
vectorLayer = QGisLayers.getObjectFromUri(input)

#接着创建输出文件，可通过SextanteVectorWriter对象来进行，该对象实为模板化的矢量输出类
provider = vectorLayer.dataProvider()
writer = SextanteVectorWriter(output, None, provider.fields(), provider.geometryType(), provider.crs() )

#然后将选择的字段添加到输出文件
selection = vectorLayer.selectedFeatures()
for feat in selection:
    writer.addFeature(feat)
del writer

def processParameterLine(self,line):
    param = None
    out = None
    line = line.replace("#", "");
    ...
    tokens = line.split("=");
    desc = self.createDescriptiveName(tokens[0])
    if tokens[1].lower().strip() == "group":
        self.group = tokens[0]
        return
    ...
    elif tokens[1].lower().strip().startswith("number"):
        tokens[0] = tokens[0].strip()  #新增语句，修改是为了剔除参数名部分不必要的空格，解决定义数字参数执行时提示变量未定义的问题
        default = tokens[1].strip()[len("number")+1:].strip()
        param = ParameterNumber(tokens[0], desc, default=default)#tokens[0]为参数名，desc为描述信息，用于显示
        return

def processAlgorithm(self, progress):
    script = "import sextante\n" #导入sextante文件
        
    #------------生成算法调用命令行字符串--------------#
    ns = {} 
    ns['progress'] = progress

    for param in self.parameters:
        #script += param.name + "=" + param.getValueAsCommandLineParameter() + "\n"
        ns[param.name] = param.value

    for out in self.outputs:
        ns[out.name] = out.value
        #script += out.name + "=" + out.getValueAsCommandLineParameter() + "\n"

    script+=self.script
        
    #-----------------执行算法----------------#
    exec(script) in ns #将参数字典作为全局名字空间
 
    #将输出结果保存到算法的输出列表中，这样后面sextante即可自动将算法输出结果加载到QGIS中
    for out in self.outputs:
        out.setValue(ns[out.name])

编写算法类

• __init__.py，定义该文件主要是为了进行provider加载前的某些操作，但sextante中一般第三方应用程序算法提供者，如OTB、SAGA、Grass等均只是简单的定义了该文件而没有实现任何内容。这也说明，该文件只是sextante的硬性规定，相当于协议而已，目前实际作用不明显；
• [算法类名(Algeorithm)].py，该文件定义了算法类及其参数等属性；
• [算法提供者(AlgorithmProvider)].py，该文件定义了算法提供者类及其相关属性；
• CMakeList.txt，该文件声明需要编译那些文件；

FILE(GLOB PY_FILES *.py)
FILE(GLOB DESCR_FILES description/*.txt)
FILE(GLOB HELP_FILES help/*.html)

PLUGIN_INSTALL(sextante preprocess ${PY_FILES})
PLUGIN_INSTALL(sextante preprocess/description ${DESCR_FILES})
PLUGIN_INSTALL(sextante preprocess/help ${HELP_FILES})

from sextante.preprocess.PreprocessAlgorithmProvider import PreprocessAlgorithmProvider

Sextante.addProvider(PreprocessAlgorithmProvider())