Usando os algoritmos do processamento a partir do Terminal Python.¶

Chamando os algoritmos a partir do Terminal Python¶

A primeira coisa que tem de fazer é importar as funções do processamento com a seguinte linha:

>>> import processing

Now, there is basically just one (interesting) thing you can do with that from the console: execute an algorithm. That is done using the runalg() method, which takes the name of the algorithm to execute as its first parameter, and then a variable number of additional parameters depending on the requirements of the algorithm. So the first thing you need to know is the name of the algorithm to execute. That is not the name you see in the toolbox, but rather a unique command–line name. To find the right name for your algorithm, you can use the alglist() method. Type the following line in your console:

>>> processing.alglist()

Irá ver algo como isto.

Accumulated Cost (Anisotropic)---------------->saga:accumulatedcost(anisotropic)
Accumulated Cost (Isotropic)------------------>saga:accumulatedcost(isotropic)
Add Coordinates to points--------------------->saga:addcoordinatestopoints
Add Grid Values to Points--------------------->saga:addgridvaluestopoints
Add Grid Values to Shapes--------------------->saga:addgridvaluestoshapes
Add Polygon Attributes to Points-------------->saga:addpolygonattributestopoints
Aggregate------------------------------------->saga:aggregate
Aggregate Point Observations------------------>saga:aggregatepointobservations
Aggregation Index----------------------------->saga:aggregationindex
Analytical Hierarchy Process------------------>saga:analyticalhierarchyprocess
Analytical Hillshading------------------------>saga:analyticalhillshading
Average With Mask 1--------------------------->saga:averagewithmask1
Average With Mask 2--------------------------->saga:averagewithmask2
Average With Thereshold 1--------------------->saga:averagewiththereshold1
Average With Thereshold 2--------------------->saga:averagewiththereshold2
Average With Thereshold 3--------------------->saga:averagewiththereshold3
B-Spline Approximation------------------------>saga:b-splineapproximation
...

Esta é a lista de todos os algoritmos disponíveis, ordenados alfabeticamente, juntamente com os seus nomes da linha de comandos correspondentes.

É possível usar uma cadeia de texto como parâmetro para este método. Em vez de retornar a lista completa de algoritmo , ele só irá exibir aqueles que incluem esta cadeia. Se, por exemplo, está procurando um algoritmo para calcular a inclinação de um MDE, digite alglist("slope") para obter o seguinte resultado:

DTM Filter (slope-based)---------------------->saga:dtmfilter(slope-based)
Downslope Distance Gradient------------------->saga:downslopedistancegradient
Relative Heights and Slope Positions---------->saga:relativeheightsandslopepositions
Slope Length---------------------------------->saga:slopelength
Slope, Aspect, Curvature---------------------->saga:slopeaspectcurvature
Upslope Area---------------------------------->saga:upslopearea
Vegetation Index[slope based]----------------->saga:vegetationindex[slopebased]

Este resultado pode mudar dependendo dos algoritmos que estão disponíveis.

Assim é mais fácil encontrar o algoritmo que procura e o seu nome da linha de comandos, neste caso saga:slopeaspectcurvature.

Uma vez conhecido o nome da linha de comandos do algoritmo, a próxima coisa a fazer é determinar a sintaxe correta para executá-lo. Isto significa saber quais os parâmetros necessários e a ordem que devem passar quando chamado pelo método runalg(). Existe um método para descrever um algoritmo em detalhe, o qual pode ser usado para obter uma lista de parâmetros que requer uns algoritmos e os arquivos de saída que irão gerar. Para fazer isso, pode usar o método alghelp(name_of_the_algorithm). Use o nome do algoritmo na linha de comando, não o nome descritivo completo.

Chamado o método saga:slopeaspectcurvature como parâmetro, você terá a seguinte descrição.

>>> processing.alghelp("saga:slopeaspectcurvature")
ALGORITHM: Slope, Aspect, Curvature
   ELEVATION <ParameterRaster>
   METHOD <ParameterSelection>
   SLOPE <OutputRaster>
   ASPECT <OutputRaster>
   CURV <OutputRaster>
   HCURV <OutputRaster>
   VCURV <OutputRaster>

Agora tem tudo o que necessita para correr qualquer algoritmo. Como já tínhamos mencionado, existe apenas um comando para executar algoritmos: runalg(). A sua síntaxe é como está descrito a seguir:

>>> processing.runalg(name_of_the_algorithm, param1, param2, ..., paramN,
         Output1, Output2, ..., OutputN)

A lista de parâmetros e arquivos de saída para adicionar dependem do algoritmo que quer correr, e é exatamente a lista que o método alghelp() lhe dá, na mesma ordem que é exibido.

Dependendo do tipo de parâmetro, os valores são introduzidos diferentemente. A próxima explicação é uma rápida revisão de como introduzir valores para cada tipo de parâmetro de entrada:

• Raster Layer, Vector Layer or Table. Simply use a string with the name that identifies the data object to use (the name it has in the QGIS Table of Contents) or a filename (if the corresponding layer is not opened, it will be opened but not added to the map canvas). If you have an instance of a QGIS object representing the layer, you can also pass it as parameter. If the input is optional and you do not want to use any data object, use None.

• Seleção. Se algum algoritmo tiver um parâmetro de seleção, o valor desse parâmetro deve ser introduzido usando um valor inteiro. Para saber as opções disponíveis, pode usar o comando algoptions(), como é exibido no seguinte exemplo:

  >>> processing.algoptions("saga:slopeaspectcurvature")
  METHOD(Method)
      0 - [0] Maximum Slope (Travis et al. 1975)
      1 - [1] Maximum Triangle Slope (Tarboton 1997)
      2 - [2] Least Squares Fitted Plane (Horn 1981, Costa-Cabral & Burgess 1996)
      3 - [3] Fit 2.Degree Polynom (Bauer, Rohdenburg, Bork 1985)
      4 - [4] Fit 2.Degree Polynom (Heerdegen & Beran 1982)
      5 - [5] Fit 2.Degree Polynom (Zevenbergen & Thorne 1987)
      6 - [6] Fit 3.Degree Polynom (Haralick 1983)
  

  Neste caso, o algoritmo tem um dos referidos parâmetros com 7 opções e sua ordenação é iniciada em zero.

• Múltiplas entradas. O valor é uma cadeia de texto com descritores de entrada separados por ponto e vírgula (;). Como no caso das camadas ou tabelas únicas, cada descritor de entrada pode ser o nome do objeto ou o caminho do arquivo.

• Campo da Tabela de XXX. Use uma cadeia de texto com o nome do campo a usar. O parâmetro é caso sensitivo.

• Tabela Fixa. Digite a lista de todos os valores da tabela separadas por vírgulas (,) e feche entre aspas ("). Os valores começam na linha superior e vai da esquerda para a direita. Pode também usar uma matriz 2D de valores que representam a tabela.

• SRC. Introduza o número do código EPSG do SRC desejado.

• Extensão. Deve usar uma cadeia de texto com xmin, xmax, ymin e ymax valores separados por vírgulas (,).

Os parâmetros booleanos, de arquivo, cadeia de texto e numéricos não necessitam de explicações adicionais.

Os parâmetros de entrada, como textos, booleanos, ou valores numéricos têm valores padrão. Para usá-los, especificar None na entrada do parâmetro correspondente.

Para objetos de saída de dados, digite o caminho de arquivo a ser utilizado para salvá-lo, como é feito a partir da caixa de ferramentas. Caso queira salvar o resultado em um arquivo temporário, use None. A extensão do arquivo determina o formato do arquivo. Se você digitar uma extensão de arquivo não suportada pelo algoritmo, será utilizado o formato de arquivo padrão para esse tipo de saída e a sua extensão correspondente anexado ao conjunto de arquivos de dados.

Unlike when an algorithm is executed from the toolbox, outputs are not added to the map canvas if you execute that same algorithm from the Python console. If you want to add an output to the map canvas, you have to do it yourself after running the algorithm. To do so, you can use QGIS API commands, or, even easier, use one of the handy methods provided for such tasks.

O método runalg retorna um dicionário com os nomes de saída (os que são exibidos na descrição do algoritmo) como chaves ou caminhos de arquivo dessas saídas como valores. Pode carregar essas camadas passando o seu caminho de arquivo correspondente pelo método load().

Funções adicionais para a manipulação dos dados¶

Apart from the functions used to call algorithms, importing the processing package will also import some additional functions that make it easier to work with data, particularly vector data. They are just convenience functions that wrap some functionality from the QGIS API, usually with a less complex syntax. These functions should be used when developing new algorithms, as they make it easier to operate with input data.

Below is a list of some of these commands. More information can be found in the classes under the processing/tools package, and also in the example scripts provided with QGIS.

• getObject(obj): Returns a QGIS object (a layer or table) from the passed object, which can be a filename or the name of the object in the QGIS Layers List

• values(layer,fields): Retorna os valores da tabela de atributos de uma camada vetorial para os campos validados. Os campos podem ser validados como nomes de campos ou índices de campo iniciados em zero. Retorna um dicionário de listas com campos de identificadores validados como chaves. Considera a seleção existente.

• features(layer): Retorna um iterador sobre as feições de uma camada vetorial, considerando a seleção existente.

• UniqueValues (layer, field): Retorna uma lista de valores exclusivos para um determinado atributo. Os atributos podem ser passado como um nome de campo ou um índice de campo baseado em zero. Ele considera a seleção existente.

Criando scripts e correndo-os a partir da caixa de ferramentas¶

Pode criar os seus próprios algoritmos através da escrita do código Python correspondente e adicionar algumas linhas extras para fornecer informação adicional necessária para definir as semânticas do algoritmo. Pode encontrar um Criar novo script menu sob o :guilabel: Tools no grupo Script bloco de algoritmos da caixa de ferramentas. Faça duplo clique nele e irá abrir um diálogo de edição do script. É onde deverá digitar o código. Guarde o script na pasta scripts (a pasta padrão quando abre o diálogo de guardar ficheiro), com a extensão .py, irá automaticamente criar o algoritmo correspondente.

O nome do algoritmo (aquele que irá ver na caixa de ferramentas) é criado a partir do nome do arquivo, removendo a extensão e substituindo os hífens inferiores com espaços em branco.

Vamos ter o seguinte código, que calcula o Índice Topográfico de Umidade (ITW) diretamente do MDE.

##dem=raster
##twi=output
ret_slope = processing.runalg("saga:slopeaspectcurvature", dem, 0, None,
                None, None, None, None)
ret_area = processing.runalg("saga:catchmentarea(mass-fluxmethod)", dem,
                0, False, False, False, False, None, None, None, None, None)
processing.runalg("saga:topographicwetnessindex(twi), ret_slope['SLOPE'],
                ret_area['AREA'], None, 1, 0, twi)

Como pode ver, o cálculo envolve 3 algoritmos, todos eles provêem do SAGA. O último deles calcula o ITW, mas necessita da camada de dados do declive e outra de acumulação de escoamento. Nós não temos estas camadas, mas uma vez que temos o MDE, podemos calculá-los chamando os algoritmos SAGA correspondentes.

A parte do código onde este processamento tem lugar não é difícil de perceber se leu-o as seções anteriores deste capítulo. Contudo, as primeiras linhas, necessitam de uma explicação adicional. Eles fornecem a informação que é necessária para tornar o código num algoritmo que possa ser corrido a partir qualquer componente do GUI, como por exemplo a caixa de ferramentas ou o modelador gráfico.

Estas linhas começam com o símbolo de duplo comentário Python (##) e tem a seguinte estrutura:

[parameter_name]=[parameter_type] [optional_values]

Aqui está uma lista de todos os tipos de parâmetros que são suportados nos scripts de processamento, sua sintaxe e alguns exemplos.

• raster. Uma camada raster.

• vector. Uma camada vetorial.

• table. Uma tabela.

• number. Um valor numérico. Um valor padrão deve ser fornecido. Por exemplo, depth=number 2.4

• string. Um campo de texto. Como no caso de valores numéricos, um valor por padrão deve ser adicionado. Por exemplo, name=string Victor

• boolean. Um valor booleano. Adicione True ou False depois de definir o valor padrão. Por exemplo, verbose=boolean True

• múltiplos raster. Um conjunto de camadas rasters de entrada.

• vetores múltiplos. Um conjunto de camadas vetoriais de entrada.

• campo. Um campo da tabela de atributos de uma camada vetorial. O nome da camada tem de ser adicionada depois da etiqueta campo. Por exemplo, se declarou um arquivo de entrada vetorial com mylayer=vector, poderá usar myfield=field mylayer para adicionar o campo a partir dessa camada como parâmetro.

• folder`. Uma pasta.

• file`. Nome do arquivo

O nome do parâmetro é o nome que será exibido ao utilizado quando executa o algoritmo, e também o nome da variável a usar no código do script. O valor introduzido pelo usuário para esse parâmetro será atribuído à variável com esse nome.

Quando é exibido o nome do parâmetro ao usuário, o nome irá ser editado para melhorar a aparência, substituindo o hífen inferior com espaços. Portanto, por exemplo, se quer que o usuário veja o parâmetro chamado Um valor numérico, pode usar o nome da variável A_numerical_value.

Layers and table values are strings containing the file path of the corresponding object. To turn them into a QGIS object, you can use the processing.getObjectFromUri() function. Multiple inputs also have a string value, which contains the file paths to all selected object, separated by semicolons (;).

Os arquivos de saída são definidos numa maneira semelhante, usando as seguintes etiquetas:

• raster de saída

• vetor de saída

• tabela de saída

• html de saída

• arquivo de saída

• número de saída

• cadeia de texto de saída

O valor atribuído às variáveis ​​de saída sempre são conjuntos de caracteres que representam o caminho dos arquivos. Corresponderá a um caminho de arquivos temporários, caso o usuário não inserir um nome de arquivo de saída.

When you declare an output, the algorithm will try to add it to QGIS once it is finished. That is why, although the runalg() method does not load the layers it produces, the final TWI layer will be loaded (using the case of our previous example), since it is saved to the file entered by the user, which is the value of the corresponding output.

Não use a o método load() nos algoritmos, mas apenas quando se trabalha com a linha do terminal. Se a camada é criada como saída de um algoritmo, deve ser declarado como tal. Caso contrário, você não será capaz de usar adequadamente o algoritmo no modelador, desde sua sintaxe (como definido pelas tags, explicado acima) não coincidirá com o que o algoritmo realmente produz.

Saídas ocultas (números e textos) não têm um valor. Em vez disso, o usuário tem que atribuir um valor a eles. Para isso, basta definir o valor de uma variável com um nome para declarar a saída. Por exemplo, se você usou esta declaração,

##average=output number

a linha seguinte irá configurar o valor de saída para 5:

average = 5

Em adição às etiquetas para os parâmetros e arquivos de saída, pode também definir o grupo onde o algoritmo será exibido, usando a etiqueta group.

Se o algoritmo leva um longo tempo para processar, é uma boa ideia informar ao usuário. Você tem uma chamada global progress disponível, com dois métodos: setText(text) e ``setPercentage(percent)` para modificar o texto de progresso e a barra de progresso.

Vários exemplos são apresentados. Por favor, verifique-os para ver exemplos reais de como criar algoritmos usando as classes do quadro de processamento. Pode clicar com o botão direito do mouse em qualquer script do algoritmo e selecionar Editar script para editar o seu código ou apenas para vê-lo.

Documentando os seus scripts¶

Como no caso dos modelos, você pode criar documentação adicional para o seu script, para explicar o que fazem e como são usados. No diálogo de edição do script irá encontrar um botão [Editar ajuda do script]. Clique nele e irá levá-lo para o diálogo de edição da ajuda. Verifique o capítulo sobre o modelador gráfico para saber mais sobre este diálogo e como usá-lo.

Os arquivos de ajuda são salvos na mesma pasta como o próprio script, adicionando a extensão .help ao nome do ficheiro. Note que, você pode editar a ajuda do seu script antes de guardá-lo pela primeira vez. Se fechar mais tarde o diálogo de ajuda do script sem salvar o script (ex.: descartá-lo) o conteúdo da ajuda que escreveu será perdido. Se o seu script já estiver salvo e associado ao nome do arquvio, o conteúdo de ajuda será salvo automaticamente.

Pré- e pós-execução de encaixe da script¶

Os scripts podem também ser usados para definir um encaixe de pré- e pós-execução que correm antes e depois do algoritmo correr. Isto pode ser usado para automatizar tarefas que serão executados quando qualquer algoritmo é executado.

A sintaxe é identica à sintaxe explicada em cima, mas uma variável global alg está disponível, representando o algoritmo que foi (ou está prestes a ser) executado.

No grupo General do diálogo de configuração do processamento irá encontrar duas entradas denominados de Pré-execução do arquivo script e Post-execution script filet onde os nomes do arquivo dos scripts a serem executados em cada caso podem ser inseridos.