Геокодировать файл (Геокодирование)

Краткая информация

Конвертирует большие локальные таблицы адресов или мест в точки в класс объектов или автономную таблицу CSV или XLS. Инструмент использует локаторы, размещенные на портале ArcGIS Enterprise.

Использование

• Этот инструмент поддерживает в качестве входных данных таблицы в следующих форматах:

  • Файлы значений, разделенных запятыми (.csv)
  • Таблицы файловой базы геоданных
  • Рабочие листы Microsoft Excel (файлы .xls и .xlsx)

  Для входных таблиц CSV, первая строка входного файла используется как имена полей для выходной таблицы, в добавление к полям, присоединяемым из локатора. Имена полей не могут содержать пробелы или специальные символы, такие как $ или *.

  Более подробно о работе с файлами Microsoft Excel в ArcGIS Pro

  Примечание:

  Самый быстрый способ вернуть результаты геокодирования с входной таблицей в виде файловой базы геоданных – это ограничить содержимое файловой базы геоданных или предоставить файловую базу геоданных, содержащую одну таблицу.

• Вы можете геокодировать адреса, хранящиеся в одном поле или в нескольких полях, либо хранящиеся в одном поле и в поле страны. В одном входном поле хранится полный адрес, например, 303 Peachtree St NE, Atlanta, GA 30308. Поддерживается несколько полей, если входные адреса разделены на несколько полей, таких как Address, City, State и ZIP для общего адреса в США. Одно входное поле содержит полный адрес, например, 303 Peachtree St NE, Atlanta, GA 3030, также поддерживается поле, где хранятся сведения о стране, связанной с адресом, например, USA.

• Некоторые локаторы поддерживают несколько полей входных адресов, например Address, Address2 и Address3. В этом случае компонент адреса может быть разделен на несколько полей, и поля адреса будут объединены во время геокодирования. Например, 100, Main St и Apt 140 в трех полях или 100 Main St и Apt 140 в двух полях в результате геокодирования образуют адрес в виде 100 Main St Apt 140.

• Этому инструменту требуется ArcGIS Enterprise 10.7 или более новая версия портала.

• Если локатор портала недоступен в качестве служебного сервиса на портале, попросите администратора портала добавить локатор как служебный сервис портала и настроить локатор для пакетного геокодирования.

• Используйте локатор на портале ArcGIS Enterprise, который был настроен на использование нескольких потоков для повышения производительности геокодирования.

• Результаты геокодирования сохраняется в той же пространственной привязке, что и локатор. Вы можете изменить пространственную привязку выхода, установив другую выходную систему координат в параметрах среды инструмента.

• Результаты геокодирования будут содержать всю информацию геокодирования, такую как очки, статус и сопоставленный адрес каждой записи, а также значения из исходной входной таблицы. Результаты геокодирования этим инструментом содержат статический снимок исходной входной таблицы, поэтому, добавление или изменение значений в исходной таблице не приводит к обновлению результатов в выходном файле. Перезапустите инструмент, чтобы создать выходной файл, содержащий эти изменения.

• Когда результаты геокодирования возвращаются как класс объектов, адреса могут повторно сопоставляться с помощью инструмента Повторно сопоставить адреса или опции Повторно сопоставить адреса, которая открывает панель Повторно сопоставить адреса.

  Примечание:

  Таблица должна быть геокодирована с локатором на портале ArcGIS Enterprise 10.8, поддерживающем несколько потоков для пакетного геокодирования.

  Более подробно о повторном сопоставлении результатов геокодирования

• При использовании входного локатора, построенного с использованием данных с z-значениями, инструмент вернет выходные данные, которые не поддерживают z-значения. Этот инструмент поддерживает только выходные 2D-данные.

• Инструмент не применяет настройки из представления локатора, созданного в ArcGIS Pro 3.2, когда оно используется как значение параметра Локатор.

Параметры

Диалог

Подпись	Описание	Тип данных
Входная таблица	Входная таблица, содержащая адреса или места для геокодирования в формате CSV, XLS или XLSX или в таблице файловой базы геоданных.	Record Set
Локатор	Локатор портала, который будет использован для геокодирования таблицы. Вы можете выбрать локатор из заполненного списка локаторов на активном портале или просмотреть на активном портале другие доступные локаторы. Локаторы, заданные на активном портале как служебные сервисы, будут доступны по умолчанию. Примечание: ArcGIS World Geocoding Service для этого инструмента отключено. Воспользуйтесь инструментом Геокодировать адреса, если вам необходимо использовать ArcGIS World Geocoding Service.	Address Locator
Сопоставление полей адресов	Поля адресов, используемые локатором, сопоставляются с полями входной таблицы адресов. Укажите Одно поле, если полный адрес хранится во входной таблице в одном поле, например, 303 Peachtree St NE, Atlanta, GA 30308. Укажите Несколько полей, если входные адреса разделены на несколько полей, например, Address, City, State и ZIP для общего адреса в США. Укажите Одно поле и поле страны, если полный адрес, например, 303 Peachtree St NE, Atlanta, GA 30308, и страна, например, USA, разбиты на два отдельных поля, таких, как Address и Country. Некоторые локаторы поддерживают несколько входных полей адресов, таких как Address, Address2 и Address3. В этом случае компонент адреса может быть разделен на несколько полей, и поля адреса будут объединены во время геокодирования. Например, 100, Main St и Apt 140 в трех полях или 100 Main St и Apt 140 в двух полях в результате геокодирования образуют адрес в виде 100 Main St Apt 140. Если вы решите не сопоставлять необязательное входное адресное поле, используемое локатором, с полем во входной таблице адресов, укажите, что отображение не требуется, выбрав <None> вместо названия поля.	Field Info
Тип выходных данных	Задает тип файла, в который будут записаны результаты геокодирования. CSV—Будет возвращен файл .csv. Класс пространственных объектов—Будет возвращен класс пространственных объектов в файловой базе геоданных. XLS—Будет возвращен файл .xls.	String
Выходное местоположение	Папка, в которую будут записаны выходные файлы с результатами геокодирования. Если выходные данные записываются в файл .csv или .xls, выходной файл будет помещен в указанную папку. Если выходными данными является класс объектов, в указанной папке будет создана файловая база геоданных, в которой будет размещен геокодированный файл объектов. Выходная файловая база геоданных и класс объектов в ней будут иметь одинаковые имена.	Workspace
Выходное имя	Имя выходных результатов геокодирования.	String
Страна или регион (Дополнительный)	Страна или страны, в которых будет проводиться поиск геокодированных адресов. Этот параметр доступен для локаторов, поддерживающих параметр страны, и позволяет ограничить область геокодирования указанными странами. Указав страну, вы, как правило, сможете увеличить точность геокодирования. Если вы выбираете Одно поле и поле страны для параметра Сопоставление полей адресов и сопоставляете поле, представляющее страны в значении параметра Входная таблица с полем Country для параметра Сопоставление полей адресов, то значение страны из параметра Входная таблица перезапишет параметр Страна или регион. Этот параметр ограничен для указанной страны или стран. Если страна не указана, геокодирование выполняется с использованием всех поддерживаемых стран локатора. Параметр Страна или регион поддерживается не всеми локаторами.	String
Предпочитаемый тип местоположения (Дополнительный)	Задает предпочитаемую выходную геометрию, которая будет возвращена для соответствий PointAddress. Варианты для этого параметра: Местоположение маршрута, которое является стороной улицы, которая может использоваться для маршрутизации, и Местоположение адреса, которое представляет собой местоположение, представляющее верхнюю точку крыши или центроид участка для адреса. Если предпочтительное местоположение не существует в данных, будет возвращено расположение по умолчанию. Для результатов геокодирования Addr_type=PointAddress атрибутивные значения x,y соответствуют координатам адреса, а значения DisplayX и DisplayY описывают координаты верхней точки крыши или центроида здания. Этот параметр не поддерживается всеми видами локаторов. Местоположение адреса—Возвращается геометрия для результатов геокодирования, которые представляют адреса таких элементов местоположений, как верхняя точка крыши, центроид участка или входная дверь. Местоположение маршрута—Будет возвращена геометрия результатов геокодирования, которые представляют местоположение рядом с обочиной улицы, которое может использоваться для маршрутизации транспортных средств. Это значение по умолчанию	String
Категория (Дополнительный)	Ограничивает типы местоположений, в которых локатором выполняется поиск, это убирает ложно положительные совпадения и ускоряет процесс поиска. Если категория не используется, геокодирование выполняется с использованием всех поддерживаемых категорий. Не для всех локаторов и не для всех стран поддерживаются все значения категорий. В целом, этот параметр используется для: Ограничения совпадений уровнями адресов или определенными типами местоположений Недопущения совпадений на нежелательных уровнях адресов Неточный поиск координат Этот параметр не поддерживается всеми видами локаторов.	String
Выходные поля (Дополнительный)	Задает выходные поля локатора, которые возвращаются в результатах геокодирования. Все—Включает все доступные выходные поля локатора в результаты геокодирования. Это значение по умолчанию Только местоположение—Поле Shape будет сохранено, если результатом геокодирования является класс пространственных объектов. Поля Shape X и Shape Y будут сохранены, если результатом является файл .csv или файл .xls. Исходные имена полей из параметра Входная таблица сохраняются с исходными именами полей. Минимальная—Добавляет следующие поля, описывающие местоположение и то, насколько хорошо оно соответствует информации в сервисе локатора: Shape, Status, Score, Match_type, Match_addr и Addr_type. Исходные имена полей из параметра Входная таблица сохраняются. Минимальные и пользовательские поля—Добавляет следующие поля, описывающие местоположение и то, насколько хорошо оно соответствует информации в локаторе, а также любые пользовательские выходные поля в результатах геокодирования: Shape, Status, Score, Match_type, Match_addr и Addr_type. Исходные имена полей из параметра Входная таблица сохраняются. Примечание: Этот параметр может быть использован со входными локаторами, созданными с помощью инструмента Создать локатор или Создать локатор объектов, которые хранятся на диске или опубликованы на Enterprise версии 10.9 или более новой. Составные локаторы, содержащие хотя бы один локатор, созданный с помощью инструмента Создать локатор объектов, не поддерживают этот параметр.	String

Производные выходные данные

Подпись	Описание	Тип данных
Выходной класс объектов	Выходной класс объектов.	Feature Class
Выходная таблица	Таблица выхода в формате CSV или XLS, в зависимости от значения Тип выходных данных.	Table

Python

arcpy.geocoding.GeocodeFile(in_table, locator, address_fields, output_type, output_location, output_name, {country}, {location_type}, {category}, {output_fields})

Имя	Описание	Тип данных
in_table	Входная таблица, содержащая адреса или места для геокодирования в формате CSV, XLS или XLSX или в таблице файловой базы геоданных.	Record Set
locator	Локатор портала, который будет использован для геокодирования таблицы. Вы можете выбрать локатор из заполненного списка локаторов на активном портале или просмотреть на активном портале другие доступные локаторы. Локаторы, заданные на активном портале как служебные сервисы, будут доступны по умолчанию. Примечание: ArcGIS World Geocoding Service для этого инструмента отключено. Воспользуйтесь инструментом Геокодировать адреса, если вам необходимо использовать ArcGIS World Geocoding Service.	Address Locator
address_fields	Каждое сопоставление полей в этом параметре имеет формат input_locator_field, table_field_name, где input_locator_field – это имя поля входного адреса, заданное локатором, а table_field_name – это имя соответствующего поля в таблице адресов, которую вы хотите геокодировать. Вы можете указать одно поле ввода, в котором хранится полный адрес, например, 303 Peachtree St NE, Atlanta, GA 30308. Кроме того, вы можете указать несколько полей, если входные адреса разделены на несколько полей, таких как Address, City, Stateи ZIP для общего адреса в США. Вы также можете указать одно входное поле, где хранится полный адрес, например, 303 Peachtree St NE, Atlanta, GA 30308, а также поле, где хранится информация о стране, связанной с адресом, например, USA. Некоторые локаторы поддерживают несколько входных полей адресов, таких как Address, Address2 и Address3. В этом случае компонент адреса может быть разделен на несколько полей, и поля адреса будут объединены во время геокодирования. Например, 100, Main St и Apt 140 в трех полях или 100 Main St и Apt 140 в двух полях в результате геокодирования образуют адрес в виде 100 Main St Apt 140. Если вы решите не сопоставлять необязательное входное адресное поле, используемое локатором, с полем во входной таблице адресов, укажите, что отображение не требуется, выбрав <None> вместо названия поля.	Field Info
output_type	Задает тип файла, в который будут записаны результаты геокодирования. CSV—Будет возвращен файл .csv. FEATURE_CLASS—Будет возвращен класс пространственных объектов в файловой базе геоданных. XLS—Будет возвращен файл .xls.	String
output_location	Папка, в которую будут записаны выходные файлы с результатами геокодирования. Если выходные данные записываются в файл .csv или .xls, выходной файл будет помещен в указанную папку. Если выходными данными является класс объектов, в указанной папке будет создана файловая база геоданных, в которой будет размещен геокодированный файл объектов. Выходная файловая база геоданных и класс объектов в ней будут иметь одинаковые имена.	Workspace
output_name	Имя выходных результатов геокодирования.	String
country [country,...] (Дополнительный)	Страна или страны, в которых будет проводиться поиск геокодированных адресов. Этот параметр доступен для локаторов, поддерживающих параметр страны, и позволяет ограничить область геокодирования указанными странами. Указав страну, вы, как правило, сможете увеличить точность геокодирования. Если поле страны в параметре in_table сопоставляется с полем Country в address_fields, то значение страны из in_table будет превалировать по сравнению с параметром country. Этот параметр ограничен для указанной страны или стран. Если страна не указана, геокодирование выполняется по всем доступным странам локатора. Укажите значение в виде двух- или трехсимвольного кода страны в списке, разделенном запятыми. См. столбец Поддерживаемые коды стран для использования входного значения. Параметр country не поддерживается всеми видами локаторов.	String
location_type (Дополнительный)	Задает предпочитаемую выходную геометрию, которая будет возвращена для соответствий POINT_ADDRESS. Варианты этого параметра – ROUTING_LOCATION, сторона улицы, которую можно использовать для построения маршрутов, либо ADDRESS_LOCATION, местоположение, находящееся на крыше здания или в центре земельного участка. Если предпочтительное местоположение не существует в данных, будет возвращено расположение ROUTING_LOCATION по умолчанию. Для результатов геокодирования Addr_type=PointAddress атрибутивные значения x,y соответствуют координатам адреса, а значения DisplayX и DisplayY описывают координаты верхней точки крыши или центроида здания. См. веб-справку к ArcGIS REST API для получения подробной информации о параметре locationType для geocodeAddresses. Этот параметр не поддерживается всеми видами локаторов. ADDRESS_LOCATION—Возвращается геометрия для результатов геокодирования, которые представляют адреса таких элементов местоположений, как верхняя точка крыши, центроид участка или входная дверь. ROUTING_LOCATION—Будет возвращена геометрия результатов геокодирования, которые представляют местоположение рядом с обочиной улицы, которое может использоваться для маршрутизации транспортных средств. Это значение по умолчанию	String
category [category,...] (Дополнительный)	Ограничивает типы местоположений, в которых локатором выполняется поиск, это убирает ложно положительные совпадения и ускоряет процесс поиска. Если категория не используется, геокодирование выполняется с использованием всех поддерживаемых категорий. Не для всех локаторов и не для всех стран поддерживаются все значения категорий. В целом, этот параметр используется для: Ограничения совпадений уровнями адресов или определенными типами местоположений Недопущения совпадений на нежелательных уровнях адресов Неточный поиск координат Этот параметр не поддерживается всеми видами локаторов. См. веб-справку к ArcGIS REST API для получения сведений о фильтрации категорий.	String
output_fields (Дополнительный)	Задает выходные поля локатора, которые возвращаются в результатах геокодирования. Примечание: Этот параметр может быть использован со входными локаторами, созданными с помощью инструмента Создать локатор или Создать локатор объектов, которые хранятся на диске или опубликованы на Enterprise версии 10.9 или более новой. Составные локаторы, содержащие хотя бы один локатор, созданный с помощью инструмента Создать локатор объектов, не поддерживают этот параметр. ALL—Включает все доступные выходные поля локатора в результаты геокодирования. Это значение по умолчанию LOCATION_ONLY—Поле Shape будет сохранено, если результатом геокодирования является класс пространственных объектов. Поля Shape X и Shape Y будут сохранены, если результатом является файл .csv или файл .xls. Исходные имена полей из параметра in_table будут сохранены с исходными именами полей. MINIMAL—Добавляет следующие поля, описывающие местоположение и то, насколько хорошо оно соответствует информации в сервисе локатора: Shape, Status, Score, Match_type, Match_addr и Addr_type. Исходные имена полей из значения параметра in_table будут сохранены. MINIMAL_AND_USER—Добавляет следующие поля, описывающие местоположение и то, насколько хорошо оно соответствует информации в локаторе в результатах геокодирования, а также любые пользовательские выходные поля, определенные пользователем: Shape, Status, Score, Match_type, Match_addr и Addr_type. Исходные имена полей из значения параметра in_table будут сохранены.	String

Производные выходные данные

Имя	Описание	Тип данных
out_feature_class	Выходной класс объектов.	Feature Class
out_table	Таблица выхода в формате CSV или XLS, в зависимости от значения Тип выходных данных.	Table

Пример кода

GeocodeFile, пример (автономный скрипт)

Следующий скрипт Python демонстрирует использование функции GeocodeFile в качестве автономного скрипта.

Примечание:

Если вы работаете с локаторами на своем портале, убедитесь, что выполнили вход и задали его в качестве активного в ArcGIS Pro. Для доступа к локатору, расположенному на портале, отличном от активного, можно выполнить аутентификацию через 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)

Параметры среды

Текущая рабочая область, Выходная система координат

Информация о лицензиях

• Basic: Обязательно Ваша учетная запись в ArcGIS Enterprise содержит права доступа на Выполнение анализа
• Standard: Обязательно Ваша учетная запись в ArcGIS Enterprise содержит права доступа на Выполнение анализа
• Advanced: Обязательно Ваша учетная запись в ArcGIS Enterprise содержит права доступа на Выполнение анализа