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 con facilidad.
Elementos de una página de referencia de herramientas
Tanto si busca la página de una herramienta como si va hasta ella expandiendo su caja de herramientas y después el conjunto de herramientas y haciendo clic para cargar la página correspondiente, encontrará lo siguiente.
Resumen e ilustración
El resumen es 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 se refieren 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 Phyton. 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.
Sintaxis (incluye una lista de parámetros)
La sección Sintaxis proporciona el formato y el conjunto de parámetros que se necesitan para ejecutar la herramienta en Python. Va seguida de una tabla donde se enumeran los parámetros con sus nombres, explicaciones y tipos de datos. Consulte la sección Descripción de la sintaxis de las herramientas para obtener una explicación detallada de esta sección de una página de referencia de herramienta.
Muestra de código
La sección Ejemplo 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 licencia detalla si la herramienta se ejecuta con niveles de licencia concretos e indica si requiere una extensión. Por ejemplo, ArcGIS for Desktop Basic: Sí significa que la herramienta se ejecutará con una licencia de ArcGIS Desktop Basic, mientras que ArcGIS for Desktop Basic: Requiere 3D Analyst significa que se ejecutará solo si la extensión 3D Analyst se usa en combinación con la licencia de ArcGIS Desktop Basic.
Descripción de la sintaxis de las herramientas
La sección Sintaxis de la página de referencia de la herramienta proporciona información detallada sobre cada parámetro de la herramienta. En ella también encontrará la sintaxis para utilizar la herramienta en Python.
Nombre y alias de la herramienta
En la primera línea debajo del encabezado de la sintaxis encontrará la firma con 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, el alias de la caja de herramientas sucede al nombre de la herramienta separado por un guión bajo. Por ejemplo, en Python, la herramienta Diferencia simétrica aparece identificada como SymDiff_analysis.
Tabla de parámetros
Tras la firma de la herramienta, se encuentra la tabla de parámetros, compuesta por tres columnas: Parámetro, Explicación y Tipo de datos. Las filas de la tabla de parámetros conservan siempre un orden de parámetros (al igual que la firma con la herramienta).
Nota:
La ayuda sobre el parámetro de los temas de la herramienta de geoprocesamiento suele describir un parámetro desde el contexto de Python. Es más destacable en parámetros booleanos y parámetros de cadenas de caracteres con palabras clave. 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 cuadro de diálogo de la herramienta puede ser diferente al orden establecido en la tabla de parámetros. En Python, utilice siempre el orden que se muestra en la tabla de parámetros.
Los parámetros de la herramienta pueden ser requeridos u opcionales. Los parámetros van seguidos de (Opcional) en el cuadro de diálogo de la herramienta.
| Tipo de parámetro | Descripción |
|---|---|
Obligatorio | 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. |
Los nombres de los parámetros opcionales pueden resultar útiles como acceso directo en Python. En lugar de omitir otros parámetros opcionales no utilizados con un conjunto vacío de comillas ("") o una almohadilla ("#"), el parámetro puede ajustarse explícitamente mediante el nombre del parámetro.
# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)Nombres de parámetros frente a etiquetas
La etiqueta del parámetro se utiliza en el cuadro de diálogo de la herramienta. Se utiliza el nombre del parámetro en la tabla de parámetros. La relación entre la etiqueta y el nombre del parámetro generalmente es obvia, pero en algunos casos, se anotará el nombre del parámetro para evitar confusiones.
Parámetros que aceptan listas
En caso de parámetros que aceptan listas de valores, la sintaxis de la lista sigue al nombre del parámetro como se indica a continuación:
| Apariencia | Descripción |
|---|---|
| Lista sencilla: las listas sencillas se conocen como parámetros multivalor. |
| Lista de listas: el tipo de datos es Tabla de valores. |
Una lista sencilla contiene una lista de valores sencillos. En el ejemplo anterior, el parámetro Distances tiene un tipo de datos doble (se muestra en la columna Tipo de datos). Esta lista se puede indicar por medio de uno de los siguientes métodos:
# Method 1: A list of numbers dist = [10.0, 20.0, 30.0]
# Method 2: A list of strings dist = ["10.0", "20.0", "30.0"]
# Method 3: String representation of a list dist = "10.0; 20.0; 30.0"El tipo de datos de un listado de listas es Tabla de valores. En el ejemplo anterior, el parámetro in_features es una lista de listas en la que una lista individual contiene la ruta a una capa o dataset de entidades y una clasificación opcional de enteros. Este parámetro se puede indicar por medio de uno de los siguientes métodos:
# Method 1: A list of lists inFeatures = [["counties", 2], ["parcels", 1], ["state"]]
# Method 2: A list of strings inFeatures = ["counties 2", "parcels 1", "state"]
# Method 3: String representation, each list separated by a semicolon inFeatures = "counties 2; parcels 1; state"Columna 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.
Las palabras clave son cadenas de caracteres y aparecen siempre entre comillas al inicializar la herramienta. Por ejemplo, la herramienta Agregar campo incorpora palabras clave para el tipo de campo siguiente:# Add a field named IDField with data type of long
arcpy.AddField_management("Parks", "IDField", "LONG", field_is_nullable="NULLABLE",
field_is_required="NON_REQUIRED")
Tipo de datos
Todos los parámetros de la 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 docenas de otros tipos de datos creados específicamente para los datos de ArcGIS, como sistema de coordenadas y extensión.
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 parámetros de entrada u otras ubicaciones conocidas, como 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.
Utilizar objetos de scripts
Los parámetros de herramientas generalmente se definen mediante cadenas de texto simple. Los nombres de datasets, rutas, palabras clave, nombres de campo, tolerancias y nombres de dominio se pueden especificar mediante una cadena de caracteres que está entre comillas.
Algunos parámetros son difíciles de definir mediante cadenas de caracteres simples; son parámetros más complejos que requieren muchas propiedades. En lugar de utilizar cadenas de texto largas y complicadas para definir estos parámetros, puede utilizar clases (por ejemplo, las clases SpatialReference, ValueTable y Point). La documentación para cada herramienta contiene un ejemplo de script de cómo se define y se utiliza cada parámetro de herramienta.
En el siguiente ejemplo, se crea un objeto SpatialReference que se utiliza para definir el sistema de coordenadas de salida de una clase de entidad creada con la herramienta Crear clase de entidad:
import arcpy
inputWorkspace = "c:/temp"
outputName = "rivers.shp"
prjFile = "c:/projections/North America Equidistant Conic.prj"
spatialRef = arcpy.SpatialReference(prjFile)
# Run CreateFeatureclass using the spatial reference object
arcpy.CreateFeatureclass_management(inputWorkspace, outputName, "POLYLINE",
"", "", "", spatialRef)En muchos flujos de trabajo de geoprocesamiento, puede que necesite ejecutar una operación concreta con información de coordenadas y geometría, pero que no desee pasar por el proceso de crear una clase de entidad (temporal), rellenarla con cursores, utilizarla y eliminarla. En su lugar, puede utilizar objetos de geometría tanto para la entrada como para la salida con el fin de facilitar el geoprocesamiento. Los objetos de geometría se pueden crear desde cero utilizando las clases Multipoint, PointGeometry, Polygon o Polyline.