Todas las páginas de herramientas de la referencia de herramientas de ArcGIS Pro tienen la misma estructura; una vez que la entienda podrá usar cualquier herramienta.
Resumen e ilustración
La sección Resumen contiene una descripción breve de lo que hace la herramienta. Puede contener vínculos a información detallada sobre el funcionamiento de la herramienta. En algunos casos, el resumen estará acompañado de una ilustración que también explica lo que hace la herramienta.
Uso
La sección Uso contiene notas y aclaraciones sobre el uso de la herramienta. Cuando las notas hacen referencia a un parámetro en particular, se utiliza la etiqueta del parámetro, que aparece en el cuadro de diálogo de la herramienta, en lugar del nombre del parámetro, que aparece en la sintaxis y se usa en Python. La relación entre la etiqueta y el nombre del parámetro generalmente es obvia, pero en algunos casos se incluye el nombre del parámetro para evitar confusiones.
Parámetros
La sección Parámetros se divide en dos pestañas: Cuadro de diálogo y Python.
La pestaña Cuadro de diálogo incluye información de parámetros para usar la herramienta en el panel Geoprocesamiento.
La pestaña Python incluye información para usar la herramienta en Python. La pestaña incluye la sintaxis de la herramienta; una tabla de parámetros con tres columnas: Nombre, Explicación y Tipo de datos y una sección Muestra de código con muestras que presentan el uso de la herramienta en Python.
Sintaxis
En la pestaña Python, la primera línea debajo del encabezado de sintaxis contiene la firma de la herramienta. En Python, se utiliza el nombre de la herramienta en lugar de la etiqueta de la herramienta.
- La etiqueta de la herramienta aparece en la parte superior de un cuadro de diálogo de herramienta.
- En Python, arcpy va seguido del alias de la caja de herramientas y el nombre de la herramienta, cada uno separado por un punto. Por ejemplo, en Python, la herramienta Diferencia simétrica aparece identificada como arcpy.analysis.SymDiff.
- Como las herramientas de las cajas de herramientas Spatial Analyst y Image Analyst por lo general se importan desde los módulos sa y ia correspondientes a Álgebra de mapas, la sintaxis de estas herramientas solo muestra el nombre de la herramienta.
Nota:
En ArcPy, las herramientas de geoprocesamiento se organizan de dos formas. Todas las herramientas están disponibles como funciones del espacio de nombre de arcpy, pero también están disponibles en módulos que coinciden con el nombre de alias de la caja de herramientas. Aunque la sintaxis muestra las herramientas de la última forma, ambos enfoques son igual de válidos. El enfoque que utilice dependerá de las preferencias personales y los hábitos de codificación.
Se puede acceder a las herramientas desde módulos que coinciden con el nombre de la caja de herramientas.
arcpy.management.GetCount(in_features)Se puede acceder a las herramientas como funciones en el módulo ArcPy.
arcpy.GetCount_management(in_features)El nombre del módulo y el nombre de la herramienta también se pueden identificar arrastrando una herramienta desde el panel Geoprocesamiento hasta la ventana de Python.
Tabla de parámetros
La tabla de parámetros tiene tres columnas: Etiqueta/Nombre, Explicación y Tipo de datos.
La tabla de parámetros varía en función de si utiliza la pestaña Cuadro de diálogo o Python; la pestaña Cuadro de diálogo muestra la etiqueta del parámetro y las descripciones están orientadas hacia el panel Geoprocesamiento, mientras que la pestaña Python muestra el nombre del parámetro y las descripciones están orientadas hacia el uso de la herramienta en Python.
Las diferencias en las dos tablas de parámetros son más notables para los parámetros booleanos y los parámetros de cadena de caracteres con palabras clave. En el cuadro de diálogo del parámetro, los parámetros booleanos se presentan como casillas de verificación y los parámetros de cadena de caracteres se presentan como etiquetas, mientras que en Python, los parámetros booleanos y de cadena de caracteres muestran opciones como palabras clave de cadena de caracteres.
Nota:
La ayuda sobre parámetros relacionada con el uso de la herramienta desde el cuadro de diálogo de la herramienta se puede ver si se desplaza sobre el botón de información 
que aparece junto a cada parámetro.
Un cuadro de diálogo de herramienta puede mostrar parámetros en un orden diferente al orden de parámetros real, por lo que, en casos muy concretos, el orden de los parámetros del panel Geoprocesamiento puede ser diferente al orden de la tabla de parámetros. En Python, utilice siempre el orden que se muestra en la tabla de parámetros.
Nombres de parámetros frente a etiquetas
La etiqueta del parámetro se utiliza en el cuadro de diálogo de la herramienta. El nombre del parámetro es para la herramienta de Python. La relación entre la etiqueta y el nombre del parámetro generalmente es obvia, pero en algunos casos se incluye el nombre del parámetro para evitar confusiones.
Los parámetros de la herramienta pueden ser requeridos u opcionales. Los parámetros opcionales van seguidos de (Opcional) en el cuadro de diálogo de la herramienta.
| Tipo de parámetro | Descripción |
|---|---|
Requerido |
Debe introducir un valor para los parámetros requeridos. Estos parámetros siempre son los primeros parámetros en el comando. |
Opcional |
Estos parámetros siempre se encuentran a continuación de los parámetros requeridos. Si no proporciona ningún valor para un parámetro opcional, se calcula y se utiliza el valor predeterminado. El valor predeterminado se describe en la columna Explicación. |
En la pestaña Python, se muestra información adicional de los parámetros que aceptan una lista de valores. La sintaxis de la lista sigue el nombre del parámetro como sigue:
| Apariencia | Descripción |
|---|---|
| Lista sencilla: a las listas sencillas se las conoce como parámetros multivalor. |
| Lista de listas: el tipo de datos es Tabla de valores. |
Explicación
Esta columna ofrece más información sobre el uso de un parámetro y cómo puede definirse, incluidas opciones de palabras clave.
Tipo de datos
Todos los parámetros de herramienta poseen un tipo de datos asociado. Entre los tipos de datos simples se encuentran las cadenas de caracteres (conjunto de caracteres alfanuméricos), los booleanos (un valor verdadero o falso) y los largos (un valor entero comprendido entre -2.147.483.648 y 2.147.483.647). Además de estos tipos de datos sencillos, existen más de cien tipos distintos de datos creados específicamente para los datos de ArcGIS, como sistema de coordenadas y extensión.
Nota:
La columna Tipo de datos incluye los tipos de datos de ArcGIS compatibles para cada parámetro. Es diferente de los tipos de Python compatibles con el parámetro. Aunque los parámetros mostrarán una variedad de tipos de datos de ArcGIS, la mayoría de los parámetros son compatibles como cadenas de caracteres de Python.
Salida derivada
Los parámetros derivados son parámetros de salida que no se introducen como valores en un cuadro de diálogo de una herramienta ni como argumentos en Python. Las herramientas tendrán salidas derivadas en estos casos:
- La herramienta calcula un valor que devuelve la herramienta, como la herramienta Obtener recuento, que ofrece un recuento de los registros de una tabla.
- La herramienta modifica datasets de entrada, como la herramienta Calcular campo, que modifica valores de campo.
- Datasets de salida cuyo nombre o ubicación están determinados por los parámetros de entrada u otras ubicaciones conocidas, como la herramienta De clase de entidad a clase de entidad, que determina la ruta de salida de los parámetros de nombre de clase de entidad y espacio de trabajo.
Valor de retorno
Muchas de las herramientas de las extensiones Spatial Analyst y Image Analyst admiten Álgebra de mapas y se accede a ellas en Python a través de un formato algebraico. Es decir, se crea un objeto cuyo nombre se identifica a la izquierda de un signo igual en base a una herramienta u operador que se indica a la derecha del signo igual. Estas herramientas incluyen una sección Valor de retorno similar a la sección Salida derivada. A pesar de que los parámetros de las secciones Valor de retorno no se expresan en Python como argumento y se devuelven como valores, no equivalen a parámetros de salida derivados y se introducen como valores en el cuadro de diálogo de una herramienta.
Muestra de código
La sección Muestra de código incluye uno o varios ejemplos que ilustran cómo se puede ejecutar y utilizar la herramienta en Python.
Entornos
La sección Entornos es una lista de las configuraciones del entorno que la herramienta respeta. Haga clic en cualquier vínculo de la lista para ir a su página de referencia. Si el ajuste del entorno tiene especial importancia para la herramienta, puede haber más información sobre él.
Información de licenciamiento
La sección Información de licenciamiento detalla si la herramienta se ejecuta con niveles de licencia concretos e indica si requiere una extensión. Por ejemplo, Basic: Sí significa que la herramienta se ejecutará con una licencia de ArcGIS Pro Basic, mientras que Basic: Requiere 3D Analyst significa que se ejecutará solo si la ArcGIS 3D Analyst extension se usa en combinación con la licencia de ArcGIS Pro Basic.