Инструмент-скрипт - это инструмент геообработки, который выполняет какой-либо скрипт или исполняемый файл. Эти скрипты выполняют инструменты-скрипты, которые используют для этого инструменты геообработки в качестве интерфейса для скрипта. При создании инструмента-скрипта вы задаете параметры, которые требуются вашему скрипту для выполнения. Основными параметрами являются входной и выходной наборы данных, имена полей и строки, которые выбираются из списка вариантов. В процессе работы инструмента-скрипта значения этих параметров передаются в скрипт и используются им.
Почти все инструменты-скрипты выполняют скрипт Python (.py), который использует ArcPy, пакет сайта Python, который устанавливается вместе с ArcGIS. ArcPy обеспечивает доступ к инструментам геообработки, а также к дополнительным функциям, классам и модулям, которые позволяют создавать как простые, так и сложные рабочие процессы. С помощью ArcPy ваш скрипт может работать со средой геообработки ArcGIS, обеспечивая такие возможности, как проецирование на лету, поддержка наборов выборки, проверка входных данных, уведомления об ошибках и запись истории геообработки.
Инструменты-скрипты создаются в наборе инструментов. Чтобы создать инструмент-скрипт, щелкните правой кнопкой на наборе инструментов на панели Каталог и выберите Новый > Скрипт.
Свойства
Когда вы создаете инструмент-скрипт, диалоговое окно этого инструмента-скрипта появляется со следующими боковыми вкладками:
- Общие
- Параметры
- Выполнение
- Проверка
Общие
Вкладка Общие содержит такие свойства, как название инструмента, подпись и описание.
Примечание:
Если ваш набор инструментов - набор инструментов прежних версий (.tbx), есть, кроме того, свойство для хранения пути к скрипту выполнения инструмента относительно файла набора инструментов. Если ваш набор инструментов - набор инструментов ArcGIS (.atbx), его поведение различается. Если скрипт находится в той же папке, что и файл .atbx или в дочерней папке относительно папки хранения .atbx, сохраняется относительный путь. Если скрипт и файл .atbx полностью разделены, сохраняется абсолютный путь.
Параметры
На вкладке Параметры представлена таблица свойств параметров, где каждая строка представляет собой отдельный параметр. По умолчанию эта таблица пустая. Для каждого параметра определяется ряд свойств, таких как надпись, отображаемая для этого параметра в пользовательском интерфейсе, тип данных, с которыми он работает, а также является ли параметр обязательным или дополнительным. Как минимум, необходимо указать параметры Подпись, Имя, Тип данных, Тип и Направление.
| Свойство | Описание |
|---|---|
Подпись | Имя параметра отображается в инструменте. |
Имя | Имя параметра в случае, когда инструмент-скрипт вызывается как функция из другого скрипта Python. |
Тип данных | Тип данных, допустимый для этого параметра. Определяет управление инструментом. Например, если вы выберете Слой объектов, вы можете взять слой с активной карты или указать соответствующий класс пространственных объектов. |
Тип | Параметры могут быть обязательными или дополнительными. Если параметр является обязательным (необходимым), необходимо ввести для него значение, иначе инструмент не будет запущен. Если параметр является дополнительным, инструмент будет работать, даже если это значение не задано. |
Направление | Параметры могут быть входными и выходными. Входные параметры описывают существующие данные, которые будут обработаны, или значения, которые используются при обработке. Выходные параметры включают данные, полученные в результате работы инструмента, или значения, которые вычислены в ходе этой работы. |
Категория | При добавлении названия категории соответствующий параметр добавляется в диалоговое окно инструмента. |
Фильтр | Фильтры позволяют задать, какие определенные типы наборов данных, полей, указанных значений или значений в диапазоне допустимы в качестве входных параметров для инструмента. Например, вы можете настроить фильтр для параметра Класс объектов таким образом, что будут использоваться только классы точечных объектов, или вы можете задать числовой параметр, и тогда допустимыми будут только значения от 1 до 10. |
Зависимость | Вы можете настроить так, чтобы один параметр зависел от значения другого параметра. Например, параметр поля зависит от параметра набора данных. |
По умолчанию | Значение подставляется автоматически, когда появляется диалоговое окно инструмента. |
Параметр среды | Значение параметра по умолчанию может быть получено из параметров среды. То есть, если задан параметр среды, его значение будет использоваться в качестве значения по умолчанию для указанного параметра, когда появляется диалоговое окно инструмента. |
Символы | Пусть к файлу слоя, который определяет символы параметра. Например, вы можете задать для параметра выходного набора данных такие же символы, как и в файле слоя, чтобы заранее определить, как он отобразится на карте после работы инструмента. |
Выполнение
Вкладка Выполнение содержит свойства, связанные с кодом выполнения инструмента-скрипта, или путь к файлу скрипта Python или R-скрипта. Эта страница также содержит возможности встраивания и защиты паролем кода выполнения инструмента-скрипта или для экспорта кода выполнения в новый файл.
Вы можете выбрать как встраивание кода выполнения в наборе инструментов, так и ссылку на внешний файл скрипта. Независимо от расположения кода выполнения, страница содержит редактор кода, который можно использовать для изменения кода выполнения; вы также можете нажать кнопку Открыть в редакторе скриптов, чтобы открыть код выполнения в редакторе скриптов. Вы можете задать понравившийся вам редактор скриптов в разделе Опции геообработки.
Проверка
На странице Проверка отображается код проверки инструмента-скрипта. Проверка позволяет настроить, как параметры инструментов будут реагировать и взаимодействовать со значениями и другими параметрами инструмента-скрипта. Код проверки написан на языке Python.
Блок кода ToolValidator Python позволяет управлять оформлением, режимами работы и сообщениями инструмента-скрипта. Вы можете редактировать код Проверки непосредственно из редактора кодов или с помощью кнопки Открыть в редакторе скриптов, чтобы открыть код проверки в редакторе скриптов, который вы указали в разделе Опции геообработки.