Структура страницы справочника по инструментам

Страница каждого инструмента в справочнике по инструментам ArcGIS Pro организована по единому шаблону; разберитесь в шаблоне, и вы сможете использовать любой инструмент.

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

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

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

Раздел Использование содержит советы и пояснения по использованию инструмента. Когда в советах по использованию описывается определенный параметр, используется подпись параметра (название параметра в диалоговом окне инструмента), а не синтаксическое имя параметра, используемое в Python. Соответствие между именем и подписью параметра как правило очевидно, но в некоторых случаях во избежание путаницы может быть приведено имя параметра.

Параметры

Раздел Параметры разделен на две вкладки: Диалог и Python.

Вкладка Диалог содержит информацию о параметрах для использования инструмента на панели Геообработка.

Вкладка Python содержит информацию по использованию инструмента в Python. Вкладка включает синтаксис инструмента; таблицу параметров с тремя столбцами: Имя, Пояснение и Тип данных; и раздел Пример кода с примерами, демонстрирующими использование инструмента в Python.

Синтаксис

На вкладке Python первая строка под заголовком синтаксиса содержит подпись инструмента. В Python, имя инструмента используется вместо подписи инструмента.

  • Подпись инструмента отображается в верхней части диалогового окна инструмента.
  • В Python, за arcpy следует псевдоним панели инструментов и имя инструмента, разделенные подчеркиванием. Например, в Python инструмент Симметричная разность идентифицируется как arcpy.analysis.SymDiff.
Примечание:

В ArcPy инструменты геообработки организованы двумя различными способами. Все инструменты доступны как функции ArcPy, но также доступны в модулях, соответствующих псевдониму набора инструментов. Хотя синтаксис показывает инструменты в последней форме, оба подхода одинаково действительны. Какой из подходов следует использовать, зависит от ваших предпочтений и привычек.

Доступ к инструментам можно получить из модулей, соответствующих названию панели инструментов.

arcpy.management.GetCount(in_features)

Доступ к инструментам можно получить как к функциям в модуле arcpy.

arcpy.GetCount_management(in_features)

Имя модуля и имя инструмента также можно определить, перетащив инструмент из панели Геообработка в окно Python.

Таблица параметров

В таблице параметров есть три столбца: Надпись/Имя, Пояснение и Тип данных.

Таблица параметров различается в зависимости от того, используете ли вы вкладку Диалог или Python; на вкладке Диалог отображается надпись параметра, а описания ориентированы на панель Геообработка, тогда как на вкладке Python отображается имя параметра, а описания ориентированы на использование инструмента в Python.

Различия в двух таблицах параметров наиболее заметны для Булевых параметров и строковых параметров с ключевыми словами. В диалоговом окне параметров Булевы параметры представлены в виде окон для отметок, а строковые параметры представлены в виде надписей, тогда как в Python, Булевы и строковые параметры показывают варианты выбора как строковые ключевые слова.

Примечание:

Параметр help, который относится к использованию инструмента из диалогового окна, также можно увидеть, наведя курсор на кнопку информации Информация рядом с каждым параметром.

В диалоговом окне инструмента параметры могут отображаться в порядке, отличном от фактического порядка параметров, поэтому в редких случаях порядок параметров на панели Геообработка может отличаться от порядка в таблице параметров. Для Python всегда используется порядок, показанный в таблице параметров.

Имена и подписи параметров

Надпись параметра, отображаемое в диалоговом окне инструмента. Имя параметра предназначено для инструмента в Python. Соответствие между надписью и именем параметра обычно очевидно, но в некоторых случаях во избежание путаницы может быть приведено имя параметра.

Параметры инструмента могут быть либо обязательными, либо необязательными. За необязательными параметрами следует (дополнительно) в диалоговом окне инструмента.

Тип параметраОписание

Обязательный

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

Дополнительный

Дополнительные параметры всегда идут после обязательных. Если вы не ввели значения для дополнительного параметра, в этом случае будет рассчитано и использовано значение по умолчанию. Значение по умолчанию приводится в столбце Объяснение.

Обязательные и необязательные параметры

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

ОформлениеОписание

Простой список

Простой список - простые списки известны как параметры с несколькими значениями.

Таблица значений

Список списков - такой тип данных называется Таблица значений.

Объяснение

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

Тип данных

Каждый параметр инструмента имеет связанный тип данных. Некоторые простые типы данных: строка (любой набор букв и цифр), булево (значение true или false) и длинное целое число (целочисленное значение от -2,147,483,648 до 2,147,483,647). Помимо этих простых типов данных, существует более сотни других типов данных, созданных специально для данных в ArcGIS, таких, как система координат и экстент.

Примечание:

Столбец Тип данных включает поддерживаемые типы данных ArcGIS для каждого параметра. Это отличается от типов Python, поддерживаемых параметром. Хотя параметры будут отображать различные типы данных ArcGIS, большинство параметров поддерживаются в виде строк Python.

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

Производные параметры являются выходными параметрами, которые не вводятся как значения в диалоговом окне инструмента или как аргументы Python. Инструменты имеют выходные производные параметры в следующих случаях:

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

Возвращаемое значение

Многие инструменты в расширениях Spatial Analyst и Image Analyst поддерживают Алгебру карт, и доступ к ним в Python осуществляется через алгебраический формат. Это значит, что объект, имя которого указано слева от знака равенства, создается с помощью инструмента или оператора, указанного справа от знака равенства. Эти инструменты включают раздел Возвращаемое значение, аналогичный разделу Производные выходные данные Хотя параметры в разделах Возвращаемое значение не выражаются в Python, в качестве аргумента и возвращаются как значения, они не похожи на производные выходные параметры и вводятся как значения в диалоговом окне инструмента.

Более подробно о Алгебре карт

Пример кода

Раздел Пример кода включает один или несколько примеров, иллюстрирующих, каким образом можно запустить инструмент с помощью кода Python.

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

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

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

В разделе Информация о лицензировании указывается необходимый для запуска инструмента уровень лицензии, а также требуется или нет лицензия для какого-либо дополнительного модуля. Например, Basic: Да означает, что инструмент будет работать с лицензией ArcGIS Pro Basic, а Basic: Необходим 3D Analyst означает, что он будет работать только в том случае, если ArcGIS 3D Analyst extension используется вместе с лицензией ArcGIS Pro Basic.