Geocodificar archivo (Geocodificación)

Resumen

Convierte grandes tablas locales de direcciones o lugares en puntos en una clase de entidad o como tabla CSV o XLS. Esta herramienta utiliza localizadores alojados en un portal de ArcGIS Enterprise.

Nota:

Esta herramienta funciona en ArcGIS AllSource 2.4 o versiones posteriores junto con un portal de ArcGIS Enterprise 10.7 o versiones posteriores.

Uso

  • Esta herramienta soporta los siguientes formatos de tabla como entrada:

    • Archivo de valores separados por comas (.csv)
    • Tablas de geodatabase de archivos
    • Hojas de cálculo de Microsoft Excel (archivos .xls y .xlsx)

    En el caso de tablas CSV de entrada, la primera fila del archivo de entrada se utiliza como los nombres de campo para la tabla de salida, además de los campos incorporados desde el localizador. Los nombres de campo no pueden contener espacios ni caracteres especiales, como $ o *.

    Más información acerca de trabajar con archivos Microsoft Excel en ArcGIS AllSource

    Nota:

    La manera más rápida de devolver los resultados de geocodificación con una tabla de entrada en forma de geodatabase de archivos es limitar el contenido de la geodatabase de archivos o proporcionar una geodatabase de archivos que contenga una única tabla.

  • Puede geocodificar direcciones almacenadas en un único campo, divididas en varios campos, o almacenadas en un solo campo y un campo de país. Un único campo de entrada almacena la dirección completa; por ejemplo, 303 Peachtree St NE, Atlanta GA 30308. Se admiten varios campos si las direcciones de entrada están divididas en varios campos, como Address, City, State y ZIP para una dirección general de Estados Unidos. Un único campo de entrada que almacene la dirección completa, por ejemplo: 303 Peachtree St NE, Atlanta GA 30308, y un campo que almacene el país asociado con la dirección, por ejemplo: EE. UU también se admite.

  • Algunos localizadores admiten varios campos de dirección de entrada tales como Address, Address2 y Address3. En este caso, el componente de dirección se puede separar en varios campos y los campos de dirección se concatenarán en el momento de la geocodificación. Por ejemplo, 100, Main St y Apt 140 en tres campos o 100 Main St y Apt 140 en dos campos se convierten en 100 Main St Apt 140 al geocodificar.

  • Se requiere un portal de ArcGIS Enterprise 10.7 o posterior para usar esta herramienta.

  • Si algún localizador del portal no está disponible como servicio de utilidades en el portal, pida a su administrador del portal que lo agregue como servicio de utilidades del portal y configure el localizador para la geocodificación por lotes.

  • Use un localizador del portal de ArcGIS Enterprise configurado para utilizar varios subprocesos para mejorar el rendimiento de geocodificación.

  • Los resultados de geocodificación se guardan en la misma referencia espacial que el localizador. Puede cambiar la referencia espacial de la salida estableciendo un sistema de coordenadas de salida diferente en la configuración del entorno de la herramienta.

  • Los resultados de geocodificación contendrán toda la información de geocodificación relevante, por ejemplo, puntuación, estado y dirección coincidente de cada registro, además de los valores de la tabla de entrada original. Los resultados de geocodificación de esta herramienta contienen una instantánea estática de la tabla de entrada original, por lo que al agregar o actualizar valores en la tabla original no se actualizarán los resultados del archivo de salida. Vuelva a ejecutar la herramienta para crear un archivo de salida que contenga dichos cambios.

  • Cuando los resultados de geocodificación se devuelven como clase de entidad, las direcciones se pueden volver a geocodificar con la herramienta Repetir geocodificación de direcciones o la opción Repetir geocodificación de direcciones que abre el panel Repetir geocodificación de direcciones.

    Nota:

    La tabla se debe geocodificar con un localizador en un portal ArcGIS Enterprise 10.8 que tenga más de un subproceso para la geocodificación por lotes.

    Obtenga más información sobre cómo repetir la geocodificación de los resultados de geocodificación.

  • Cuando se utiliza un localizador de entrada creado con datos sensible a valores z, la herramienta devolverá resultados no sensible a valores z. Esta herramienta solo admite salidas 2D.

  • La herramienta no aplica las configuraciones de una vista de localizador creada en ArcGIS Pro 3.2 cuando se utiliza como valor del parámetro Localizador.

Parámetros

EtiquetaExplicaciónTipo de datos
Tabla de entrada

La tabla de entrada que contiene direcciones o lugares para geocodificar en formato CSV, XLS o XLSX, o en una tabla de geodatabase de archivos.

Record Set
Localizador

El localizador del portal que se utilizará para geocodificar la tabla.

Puede elegir un localizador de la lista rellenada de localizadores del portal activo o navegar por el portal activo en busca de otros localizadores disponibles. Los localizadores que hayan sido definidos como servicios de utilidad en el portal activo estarán disponibles de forma predeterminada.

Nota:

La opción ArcGIS World Geocoding Service está deshabilitada para esta herramienta. Use la herramienta Geocodificar direcciones si desea utilizar ArcGIS World Geocoding Service.

Address Locator
Asignación de campos de dirección

Los campos de dirección que utiliza el localizador se asignan a campos de la tabla de entrada de direcciones. Especifique Campo único si la dirección completa se almacena en un solo campo de la tabla de entrada, por ejemplo, 303 Peachtree St NE, Atlanta, GA 30308. Especifique Varios campos si las direcciones de entrada están divididas en varios campos como Address, City, State y ZIP para una dirección genérica de Estados Unidos. Especifique Campo único y Campo de país si la dirección completa, por ejemplo, 303 Peachtree St NE, Atlanta, GA 30308, y el país, por ejemplo, EE. UU., se dividen en campos separados como Address y Country.

Algunos localizadores admiten varios campos de direcciones de entrada tales como Address, Address2 y Address3. En este caso, el componente de dirección se puede separar en varios campos y los campos de dirección se concatenarán en el momento de la geocodificación. Por ejemplo, 100, Main st y Apt 140 en tres campos, o 100 Main st y Apt 140 en dos campos, ambos se convertirían en 100 Main st Apt 140 al geocodificar.

Si no asigna un campo de dirección de entrada opcional empleado por el localizador a un campo de la tabla de entrada de direcciones, especifique que no hay asignación utilizando <Ninguno> en lugar de un nombre de campo.

Field Info
Tipo de Salida

Especifica el tipo de archivo en el que se escribirán los resultados de la geocodificación.

  • CSVSe devolverá un archivo .csv.
  • Clase de entidadSe devolverá una clase de entidad en una geodatabase de archivos.
  • XLSSe devolverá un archivo .xls.
String
Localización de salida

La carpeta en la que se escribirán los resultados de la geocodificación de salida.

Si la salida es un archivo .csv o .xls, se colocará un archivo de salida en la carpeta especificada.

Si la salida es una clase de entidad, se creará una geodatabase de archivos de salida y se colocará en la carpeta especificada, y la nueva geodatabase de archivos contendrá la clase de entidad geocodificada. La geodatabase de archivos de salida y la clase de entidad de la geodatabase de archivos tendrán el mismo nombre.

Workspace
Nombre de salida

El nombre de los resultados geocodificados de salida.

String
País
(Opcional)

El país o países en los que se buscarán las direcciones geocodificadas.

Este parámetro está disponible para los localizadores que admiten un parámetro de país y limitará la geocodificación a los países especificados. Especificar un país mejorará la precisión de la geocodificación en la mayoría de los casos. Si especifica Campo único y Campo de país en el parámetro Asignación de campos de dirección y asigna un campo que representa los países en el valor del parámetro Tabla de entrada al campo Country para el parámetro Asignación de campos de dirección, el valor de país de la Tabla de entrada sobreescribirá el parámetro País.

Esta opción está limitada al país o los países especificados. Cuando no se especifica ningún país, la geocodificación se realiza utilizando todos los países compatibles del localizador.

El parámetro País no es compatible con todos los localizadores.

String
Tipo de ubicación preferida
(Opcional)

Especifica la geometría de salida preferida que se devolverá para las coincidencias de PointAddress. Las opciones para este parámetro son Ubicación de generación de rutas, que es la ubicación del lado de la calle, que puede usarse para la generación de rutas, y Ubicación de dirección, que es la ubicación que representa el tejado o el centroide de parcela que corresponde a la dirección. Si la ubicación deseada no existe en los datos, se devolverá la ubicación predeterminada. En los resultados de geocodificación con Addr_type=PointAddress, los valores del atributo x,y describen las coordenadas de la dirección a lo largo de la calle, y los valores de DisplayX y DisplayY describen las coordenadas de tejado o centroide de edificio.

Este parámetro no es compatible con todos los localizadores.

  • Ubicación de direcciónSe devolverá la geometría para los resultados de geocodificación que representan una ubicación de dirección, por ejemplo, una ubicación de cubierta, un centroide de parcela o una entrada principal.
  • Ubicación de generación de rutasSe devolverá la geometría para los resultados de geocodificación que representan una ubicación cercana al lado de la calle, que se puede utilizar para la generación de rutas para vehículos. Esta es la opción predeterminada.
String
Categoría
(Opcional)

Limita los tipos de lugares que busca el localizador, eliminando así las coincidencias de falsos positivos y aumentando potencialmente el proceso de búsqueda. Cuando no se utiliza ninguna categoría, la geocodificación se realiza utilizando todas las categorías compatibles. No todos los valores de categoría son compatibles con todas las ubicaciones y países. En general, este parámetro se puede utilizar para:

  • Limitar las coincidencias de tipos de lugares o niveles de dirección específicos
  • Evitar coincidencias de reserva en niveles de dirección no deseados
  • Evitar la ambigüedad en búsquedas de coordenadas

Este parámetro no es compatible con todos los localizadores.

String
Campos de salida
(Opcional)

Especifica los campos de salida del localizador que se devolverán en los resultados de geocodificación.

  • TodasIncluye todos los campos de salida del localizador disponibles en los resultados de geocodificación. Esta es la opción predeterminada.
  • Solo ubicaciónEl campo Shape se almacenará si el resultado de geocodificación es una clase de entidad. Los campos Shape X y Shape Y se almacenarán si el resultado es un archivo .csv o .xls. Los nombres de campo originales del parámetro Tabla de entrada se mantendrán con sus nombres de campo originales.
  • MínimaAgrega los siguientes campos que describen la ubicación y el grado de coincidencia de la información del localizador en los resultados de geocodificación: Shape, Status, Score, Match_type, Match_addr y Addr_type. Los nombres de campo originales del valor del parámetro Tabla de entrada se mantendrán.
  • Campos de usuario y mínimoAgrega los siguientes campos que describen la ubicación y el grado de coincidencia de la información del localizador, así como cualquier campo de salida personalizado y definido por el usuario en los resultados de geocodificación: Shape, Status, Score, Match_type, Match_addr y Addr_type. Los nombres de campo originales del valor del parámetro Tabla de entrada se mantendrán.
Nota:

Este parámetro se puede utilizar con localizadores de entrada creados con las herramientas Crear localizador o Crear localizador de entidades publicados en Enterprise 10.9 o posterior. Los localizadores compuestos que contienen al menos un localizador creado con la herramienta Crear localizador de direcciones no admiten este parámetro.

String

Salida derivada

EtiquetaExplicaciónTipo de datos
Clase de entidad de salida

La clase de entidad de salida.

Feature Class
Tabla de Salida

La tabla de salida en formato CSV o XLS, en función del valor de Tipo de salida.

Table

arcpy.geocoding.GeocodeFile(in_table, locator, address_fields, output_type, output_location, output_name, {country}, {location_type}, {category}, {output_fields})
NombreExplicaciónTipo de datos
in_table

La tabla de entrada que contiene direcciones o lugares para geocodificar en formato CSV, XLS o XLSX, o en una tabla de geodatabase de archivos.

Record Set
locator

El localizador del portal que se utilizará para geocodificar la tabla.

Puede elegir un localizador de la lista rellenada de localizadores del portal activo o navegar por el portal activo en busca de otros localizadores disponibles. Los localizadores que hayan sido definidos como servicios de utilidad en el portal activo estarán disponibles de forma predeterminada.

Nota:

La opción ArcGIS World Geocoding Service está deshabilitada para esta herramienta. Use la herramienta Geocodificar direcciones si desea utilizar ArcGIS World Geocoding Service.

Address Locator
address_fields

Cada asignación de campos en este parámetro está en el formato input_locator_field, table_field_name, donde input_locator_field es el nombre del campo de dirección de entrada especificado por el localizador y table_field_name es el nombre del campo correspondiente en la tabla de direcciones que se desea geocodificar.

Puede especificar un único campo de entrada que almacene la dirección completa; por ejemplo, 303 Peachtree St NE, Atlanta GA 30308. Otra alternativa es especificar varios campos si las direcciones de entrada están divididas en diferentes campos, como Address, City, State y ZIP para una dirección general de Estados Unidos. También puede especificar un único campo de entrada que almacene la dirección completa, por ejemplo: 303 Peachtree St NE, Atlanta, GA 30308, y un campo que almacene el país asociado con la dirección, por ejemplo: EE. UU.

Algunos localizadores admiten varios campos de direcciones de entrada tales como Address, Address2 y Address3. En este caso, el componente de dirección se puede separar en varios campos y los campos de dirección se concatenarán en el momento de la geocodificación. Por ejemplo, 100, Main st y Apt 140 en tres campos, o 100 Main st y Apt 140 en dos campos, ambos se convertirían en 100 Main st Apt 140 al geocodificar.

Si no asigna un campo de dirección de entrada opcional empleado por el localizador a un campo de la tabla de entrada de direcciones, especifique que no hay asignación utilizando <None> en lugar de un nombre de campo.

Field Info
output_type

Especifica el tipo de archivo en el que se escribirán los resultados de la geocodificación.

  • CSVSe devolverá un archivo .csv.
  • FEATURE_CLASSSe devolverá una clase de entidad en una geodatabase de archivos.
  • XLSSe devolverá un archivo .xls.
String
output_location

La carpeta en la que se escribirán los resultados de la geocodificación de salida.

Si la salida es un archivo .csv o .xls, se colocará un archivo de salida en la carpeta especificada.

Si la salida es una clase de entidad, se creará una geodatabase de archivos de salida y se colocará en la carpeta especificada, y la nueva geodatabase de archivos contendrá la clase de entidad geocodificada. La geodatabase de archivos de salida y la clase de entidad de la geodatabase de archivos tendrán el mismo nombre.

Workspace
output_name

El nombre de los resultados geocodificados de salida.

String
country
[country,...]
(Opcional)

El país o países en los que se buscarán las direcciones geocodificadas.

Este parámetro está disponible para los localizadores que admiten un parámetro de país y limitará la geocodificación a los países especificados. Especificar un país mejorará la precisión de la geocodificación en la mayoría de los casos. Si un campo que representa a los países en el parámetro in_table se asigna al campo Country de address_fields, el valor del país del parámetro in_table invalidará el parámetro country.

Esta opción está limitada al país o los países especificados. Cuando no se especifica ningún país, la geocodificación se realiza en todos los países compatibles del localizador.

Especifique el valor como códigos de país de dos o tres caracteres en una lista separada por comas. Consulte la columna Códigos de país admitidos para ver el valor de entrada que se debe utilizar.

El parámetro country no es compatible con todos los localizadores.

String
location_type
(Opcional)

Especifica la geometría de salida preferida que se devolverá para las coincidencias de POINT_ADDRESS. Las opciones para este parámetro son ROUTING_LOCATION, que es la ubicación del lado de la calle, que puede usarse para la generación de rutas, y ADDRESS_LOCATION, que es la ubicación que representa el tejado, el centroide de parcela que corresponde a la dirección o una entrada principal. Si la ubicación deseada no existe en los datos, se devolverá la ubicación predeterminada de ROUTING_LOCATION. En los resultados de geocodificación con Addr_type=PointAddress, los valores del atributo x,y describen las coordenadas de la dirección a lo largo de la calle, y los valores de DisplayX y DisplayY describen las coordenadas de tejado o centroide de edificio. Consulte la página web de la Ayuda de API REST de ArcGIS para obtener más información sobre el parámetro locationType para geocodeAddresses.

Este parámetro no es compatible con todos los localizadores.

  • ADDRESS_LOCATIONSe devolverá la geometría para los resultados de geocodificación que representan una ubicación de dirección, por ejemplo, una ubicación de cubierta, un centroide de parcela o una entrada principal.
  • ROUTING_LOCATIONSe devolverá la geometría para los resultados de geocodificación que representan una ubicación cercana al lado de la calle, que se puede utilizar para la generación de rutas para vehículos. Esta es la opción predeterminada.
String
category
[category,...]
(Opcional)

Limita los tipos de lugares que busca el localizador, eliminando así las coincidencias de falsos positivos y aumentando potencialmente el proceso de búsqueda. Cuando no se utiliza ninguna categoría, la geocodificación se realiza utilizando todas las categorías compatibles. No todos los valores de categoría son compatibles con todas las ubicaciones y países. En general, este parámetro se puede utilizar para:

  • Limitar las coincidencias de tipos de lugares o niveles de dirección específicos
  • Evitar coincidencias de reserva en niveles de dirección no deseados
  • Evitar la ambigüedad en búsquedas de coordenadas

Este parámetro no es compatible con todos los localizadores.

Consulte la página web de Ayuda de API REST de ArcGIS para obtener más información sobre el filtrado por categoría.

String
output_fields
(Opcional)

Especifica los campos de salida del localizador que se devolverán en los resultados de geocodificación.

Nota:

Este parámetro se puede utilizar con localizadores de entrada creados con las herramientas Crear localizador o Crear localizador de entidades publicados en Enterprise 10.9 o posterior. Los localizadores compuestos que contienen al menos un localizador creado con la herramienta Crear localizador de direcciones no admiten este parámetro.

  • ALLIncluye todos los campos de salida del localizador disponibles en los resultados de geocodificación. Esta es la opción predeterminada.
  • LOCATION_ONLYEl campo Shape se almacenará si el resultado de geocodificación es una clase de entidad. Los campos Shape X y Shape Y se almacenarán si el resultado es un archivo .csv o .xls. Los nombres de campo originales del parámetro in_table se mantendrán con sus nombres de campo originales.
  • MINIMALAgrega los siguientes campos que describen la ubicación y el grado de coincidencia de la información del localizador en los resultados de geocodificación: Shape, Status, Score, Match_type, Match_addr y Addr_type. Los nombres de campo originales del valor del parámetro in_table se mantendrán.
  • MINIMAL_AND_USERAgrega los siguientes campos que describen la ubicación y el grado de coincidencia de la información del localizador en los resultados de geocodificación, así como cualquier campo de salida personalizado y definido por el usuario: Shape, Status, Score, Match_type, Match_addr y Addr_type. Los nombres de campo originales del valor del parámetro in_table se mantendrán.
String

Salida derivada

NombreExplicaciónTipo de datos
out_feature_class

La clase de entidad de salida.

Feature Class
out_table

La tabla de salida en formato CSV o XLS, en función del valor de Tipo de salida.

Table

Muestra de código

Ejemplo de GeocodeFile (script independiente)

La siguiente secuencia de comandos Pythonindependiente muestra cómo utilizar la función GeocodeFile en una secuencia de comandos independiente.

Nota:
Si está trabajando con localizadores en su portal, asegúrese de que ha iniciado sesión y configúrelo como el portal activo en ArcGIS AllSource. Para acceder a un localizador que está en un portal distinto del portal activo, autentíquelo con la función SignInToPortal.

import arcpy

# Input is a local table
input_table = r"C:\data\customers.csv"

# This tool works with locators on a portal
in_locator = "https://<machine_name>/server/rest/services/<service_name>/GeocodeServer/<service_name>"

# The best way to generate a field mapping is to run the tool in ArcGIS 
# Pro, right-click the green success ribbon, and click "Copy Python command"

field_mapping = "'Address or Place' Address VISIBLE NONE;Address2 <None> VISIBLE NONE;Address3 <None> VISIBLE NONE;Neighborhood <None> VISIBLE NONE;
City <None> VISIBLE NONE;County <None> VISIBLE NONE;State <None> VISIBLE NONE;ZIP ZIP VISIBLE NONE;ZIP4 <None> VISIBLE NONE;Country <None> VISIBLE NONE"
output_type = "FEATURE_CLASS"

# Output folder for the output CSV, Excel, or GDB table. If you select 
# FEATURE_CLASS output_type, a new GDB will be created in the 
# output_folder with the geocoding results
output_folder = r"C:\data\outputs"
output_name = "Geocoding_output"

# Optional geocoding parameters. Only some are supported depending on the 
# in_locator that you use.
country = None
location_type = "ROUTING_LOCATION"
category = "'Street Address'"

arcpy.geocoding.GeocodeFile(input_table, in_locator, field_mapping, output_type, 
                            output_folder, output_name, country, location_type, 
                            category)