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

Каждая страница справки инструмента геообработки в ArcGIS Pro имеет единообразную структуру. В этом разделе описывается эта структура и объясняется назначение каждого раздела.

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

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

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

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

Параметры

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

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

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

Синтаксис

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

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

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

• Поскольку инструменты в наборах Spatial Analyst и Image Analyst обычно импортируются из модулей sa и ia для Алгебры карт, синтаксис этих инструментов включает только название инструмента.

Примечание:

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

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

arcpy.management.GetCount(in_features)

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

arcpy.management.GetCount(in_features)

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

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

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

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

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

Примечание:

Справку по параметру также можно просмотреть при наведении указателя мыши на кнопку информации рядом с каждым параметром.

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

Литература

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

Связанные разделы

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