Информация по инструменту страницы справочника по инструментам в ArcGIS Pro организована по единому шаблону; понимание структуры страницы справочника позволит вам быстро найти нужную информацию по каждому инструменту.
Элементы страницы справочника по инструментам
Не важно, каким образом вы попали на страницу – нашли по поиску, или развернули соответствующий набор и группу инструментов, чтобы открыть нужную страницу – вы увидите определенным образом организованную статью.
Краткая информация и иллюстрация
Краткая информация – несколько предложений, описывающих, какую операцию выполняет данный инструмент. Может содержать ссылку на более подробные сведения о работе инструмента. В ряде случаев краткая информация также сопровождается поясняющей иллюстрацией.
Использование
Раздел Использование содержит советы и пояснения по использованию инструмента. Когда в советах по использованию описывается определенный параметр, используется подпись параметра (название параметра в диалоговом окне инструмента), а не синтаксическое имя параметра, используемое в Python. Соответствие между именем и подписью параметра как правило очевидно, но в некоторых случаях во избежание путаницы может быть приведено имя параметра.
Синтаксис (включает список параметров)
В разделе Синтаксис приведен набор требуемых параметров и особенности формата кодовой строки, необходимые для запуска инструмента в Python. Затем следует таблица с перечислением всех параметров с их именами, разъяснениями и типами данных. См. Расшифровка синтаксиса инструмента ниже для подробной информации об этом разделе в странице справочника.
Пример кода
Раздел Пример кода включает один или несколько примеров, иллюстрирующих, каким образом можно запустить инструмент с помощью кода Python.
Параметры среды
Раздел Параметры среды содержит списокпараметров среды, которые использует инструмент. Щелкнув любую ссылку в этом списке, вы попадете на соответствующую страницу с подробным описанием. Если конкретный параметр среды особенно важен для инструмента, может быть приведена более подробная информация о этом параметре.
Информация о лицензиях
В разделе Информация о лицензировании указывается необходимый для запуска инструмента уровень лицензии, а также требуется или нет лицензия какого-либо дополнительного модуля. Например, ArcGIS for Desktop Basic: Да означает, что этот инструмент можно запустить с лицензией ArcGIS Desktop Basic, а ArcGIS for Desktop Basic: Требуется 3D Analyst означает, что инструмент можно запустить, только если у пользователя установлен дополнительный модуль 3D Analyst при уровне лицензии ArcGIS Desktop Basic.
Расшифровка синтаксиса инструмента
В разделе Синтаксис справочной страницы инструмента содержатся сведения для каждого параметра инструмента. В нем также содержится синтаксис для использования инструмента в Python.
Имя и псевдоним инструмента
Первая строка под заголовком синтаксиса содержит подпись инструмента. В окне Python имя инструмента используется вместо метки инструмента.
- Подпись инструмента отображается в верхней части диалогового окна инструмента.
- В Python псевдоним набора инструментов следует после имени инструмента, разделенный подчеркиванием. Например, в Python инструмент Симметричная разность идентифицируется как SymDiff_analysis.
Таблица параметров
После подписи инструмента идет таблица параметров с тремя столбцами: Параметр (Parameter), Объяснение (Explanation) и Тип данных (Data Type). Строки в таблице параметров всегда находятся в порядке параметров (аналогично подписи инструмента).
Примечание:
Параметр help в разделах по инструментам геообработки часто описывает применение параметра в контексте Python. Это особенно справедливо для параметров Boolean и string с ключевыми словами. Параметр help, который относится к использованию инструмента из диалогового окна, можно увидеть, наведя курсор на кнопку информации 
рядом с каждым параметром.
Диалоговое окно инструмента может отображать параметры в порядке, отличном от фактического порядка. Таким образом, в редких случаях порядок параметров в диалоговом окне инструмента может отличаться от порядка в таблице параметров. Для Python всегда используется порядок, показанный в таблице параметров.
Параметры инструмента могут быть либо обязательными, либо необязательными. Необязательные параметры идентифицированы меткой (дополнительно) в диалоговом окне инструмента.
| Тип параметра | Описание |
|---|---|
Обязательный | Вы должны ввести значение для требующегося параметра. Эти типы параметров в команде всегда находятся первыми. |
Дополнительное | Необязательные параметры всегда идут после обязательных. Если вы не ввели значения для дополнительного параметра, в этом случае будет рассчитано и использовано значение по умолчанию. Значение по умолчанию приводится в столбце Объяснение. |
Имена необязательных параметров могут быть полезными как меню быстрого доступа в Python. Вместо того, чтобы пропускать другие неиспользуемые необязательные параметры с пустым набором кавычек ("") или со знаком решетки ("#"), параметр можно четко настроить с помощью его имени.
# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)Имена и подписи параметров
Надпись параметра, отображаемое в диалоговом окне инструмента. Имя параметра используется в таблице параметров. Соответствие между надписью и именем параметра обычно очевидно, но в некоторых случаях во избежание путаницы может быть приведено имя параметра.
Параметры, для которых задаются списки значений
Синтаксис параметров, для которых задается список значений, прописывается под именем параметра, как показано ниже:
| Оформление | Описание |
|---|---|
| Простой список; Так же можно описать как параметры с несколькими значениями. |
| Списка списков: Такой тип данных называется Таблица значений. |
Простой список содержит список отдельных значений. В примере выше параметр Distances имеет тип данных double (как показано в столбце Тип данных). Этот список можно выразить с помощью одного из перечисленных ниже методов:
# 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"Типом данных списка списков является Таблица значений. В примере выше, параметр in_features является списком списков, в котором отдельный список содержит путь к набору данных объектов или слою и дополнительному разряду целого числа. Этот параметр можно выразить с помощью одного из перечисленных ниже методов:
# 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"Столбец Объяснение
В данном столбце содержится информация о том, для чего используется параметр и как его можно настроить, включая опции ключевых слов.
Ключевые слова являются строками. Они всегда заключены в кавычки при вызове инструмента. Например, инструмент Добавить поле имеет ключевые слова для следующего типа поля:# 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")
Тип данных
Каждый параметр инструмента имеет связанный тип данных. Некоторые простые типы данных: строка (любой набор букв и цифр), булево (значение true или false) и длинное целое число (целочисленное значение от -2,147,483,648 до 2,147,483,647). В дополнение к этим простым типам данных существуют десятки других типов данных, специально построенных для данных в ArcGIS, такие как система координат и экстент.
Производные выходные данные
Производные параметры являются выходными параметрами, которые не вводятся как значения в диалоговом окне инструмента или как аргументы Python. Инструменты имеют выходные производные параметры в следующих случаях:
- Инструмент вычисляет значение, которое возвращается инструментом, таким как инструмент Посчитать строки, который возвращает число записей в таблице.
- Инструмент изменяет входные наборы данных, например, Вычислить поле, который модифицирует значения полей.
- Выходные наборы данных, имя или расположение которых определяется по входным параметрам или другим известным местоположениям, например, Класс объектов в класс объектов, который определяет выходной путь по рабочей области и параметрам имени класса объектов.
Использование объектов написания скриптов
Параметры инструментов обычно определяются с использованием простых текстовых строк. Имена набора данных, пути, ключевые слова, имена полей, допуски и имена доменов могут указываться с использованием строк в кавычках.
Некоторые параметры труднее задать с использованием простых строк; это комплексные параметры, для которых необходимо задать много свойств. Вместо того, чтобы задавать длинные, сложные текстовые строки, определяющие эти параметры, можно использовать классы (например, классы SpatialReference, ValueTable и Point). Документация для каждого инструмента содержит пример создания скриптов для задания и применения каждого параметра инструмента.
В следующем примере создается объект SpatialReference, который затем используется для задания выходной системы координат класса пространственного объекта, создаваемого с использованием инструмента Создать класс пространственных объектов:
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)Во многих рабочих потоках геообработки может потребоваться запустить определенную операцию, используя информацию о координатах и геометрии, при этом не желая проходить процесс создания (временного) класса пространственных объектов, отображения класса пространственных объектов с помощью курсоров, использования класса пространственных объектов, и последующего удаления временного класса пространственных объектов. Чтобы упростить геообработку, вместо этого в качестве входных и выходных данных можно использовать объекты геометрии. Объекты геометрии могут создаваться с нуля с помощью классов Multipoint, PointGeometry, Polygon или Polyline.