Cómo saber los parámetros de los algoritmos de PyQGIS

En la mayoría de las ocasiones, cuando queremos ejecutar un algoritmo (conocido también como herramienta) en nuestro script de QGIS, nos encontramos con que no sabemos qué parámetros necesita el algoritmo, cuáles son opcionales, y qué tipo de dato requiere cada uno de ellos.

Pues bien, conocer sus parámetros se puede hacer fácilmente desde la documentación de QGIS o desde la propia consola de Python que incluye QGIS.

1. Desde la documentación de QGIS

La documentación de QGIS (también conocida como la guía de usuario de QGIS) incluye infinidad de información que nos facilita el uso del programa. Si entramos a la documentación, veremos multitud de apartados. En este caso, para conseguir información sobre los algoritmos, nos interesa el apartado 23: Proveedor de procesos y algoritmos.

En este apartado se nos ofrece información de cada unos de los algoritmos, tanto de los nativos de QGIS, como de los externos (GDAL, LAStools…).

Si entramos, por ejemplo, al apartado 23.1. Proveedor de algoritmos de QGIS, tendremos numerosos subapartados referentes a los diferentes tipos de algoritmos de QGIS (Análisis vectorial, Herramientas de ráster, Análisis de red, etc). Dentro de cada subapartado, tenemos de nuevo más apartados con cada una de las herramientas.

Por ejemplo, dentro del apartado 23.1.16 Superposición vectorial, tengo la herramienta “Intersección”.

Si hacemos click en el algoritmo nos aparecerá una descripción de lo que hace la herramienta y, lo que viene al caso en esta entrada, los parámetros de la herramienta. Si nos fijamos, el algoritmo “Intersección” necesita una capa de entrada vectorial (INPUT), una capa vectorial de superposición (OVERLAY), los campos que queremos mantener de la capa de entrada (INPUT_FIELDS) y de la capa de superposición (OVERLAY_FIELDS), el prefijo de los campos superpuestos (OVERLAY_FIELDS_PREFIX) y la salida (OUTPUT).

Es muy importante fijarse en los parámetros que son opcionales (donde en la columna etiqueta aparece “Opcional”), en el tipo de dato que requiere cada parámetro y en la descripción, donde nos puede indicar, por ejemplo, el valor predeterminado que toma si no se le especifica ningún valor.
También nos es de mucha utilidad información que viene más abajo, acerca de cómo ejecutar el algoritmo (ID del algoritmo y su procesamiento dentro del script).

2. A través de la consola de Python de QGIS

Si tenemos el ID del algoritmo y estamos trabajando directamente sobre la consola de Python, podemos consultar cuáles son los parámetros de ese algoritmo.
Por si no lo sabéis, es posible consultar el ID del algoritmo situando el cursor del ratón justo encima de una herramienta (“qgis” es un alias de “native”, por lo que en los algoritmos podemos usar ambos).

Con el ID del algoritmo ya podemos conocer los parámetros en la consola introduciendo el ID como argumento de la función algorithmHelp(). Por tanto, si en la consola de Python de QGIS escribimos: processing.algorithmHelp(“native:intersection”).

Como observamos, nos aparecen los parámetros, los tipos de datos que aceptan y una breve descripción del parámetro.

Si quieres aprender más sobre Python y QGIS no dudes en contactarnos para más información sobre nuestro Curso online de PyQGIS.

(2 votos, promedio: 5,00 de 5)

Cargando...

Formación de calidad impartida por profesionales