env

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

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

Обсуждение

Начиная с ArcGIS Pro 2.9, недопустимые имена переменных будут приводить к сбою с пометкой AttributeError.

Свойства

СвойствоОписаниеТип данных
addOutputsToMap
(чтение и запись)

Определяет, будут ли отображаться в приложении выходные наборы данных. Свойство применимо, только если оно используется напрямую в окне Python или из блокнота в ArcGIS Pro.

Boolean
annotationTextStringFieldLength
(чтение и запись)

Инструменты, которые учитывают параметр среды Длина поля текстовой строки аннотации, переопределяют длину поля по умолчанию для поля TextString в любых классах объектов аннотаций, созданных в базе данных.

Более подробно о annotationTextStringFieldLength

Long
autoCancelling
(чтение и запись)

Задает, будет ли отмена приводить к окончанию скрипта на текущей строке. Если True, то будет. Если False, отмена задаст для свойства isCancelled значение True, и продолжится выполнение. По умолчанию – True.

Используйте в инструментах-скриптах и инструментах набора Python.

Более подробно о поведении отмены

Boolean
autoCommit
(чтение и запись)

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

Более подробно о autoCommit

Long
baDataSource
(чтение и запись)

Инструменты, поддерживающие параметр среды Источник данных, соответствуют тому, как данные суммируются с одного слоя на другой. Этот параметр среды используется только инструментами Business Analyst.

Более подробно о baDataSource

String
baNetworkSource
(чтение и запись)

Инструменты, которые поддерживают среду источника данных, позволяют вам настроить набор сетевых данных или сервис сети, используемые для задач вычисления расстояния по сети. Используется только инструментами Business Analyst.

Более подробно о baNetworkSource

String
baUseDetailedAggregation
(чтение и запись)

Инструменты, которые учитывают параметр Использовать детализированную агрегацию, будут использовать метод детализированной агрегации для областей в пределах заданного радиуса. Этот параметр среды используется только инструментами Business Analyst.

Более подробно о baUseDetailedAggregation

Boolean
buildStatsAndRATForTempRaster
(чтение и запись)

Указывает, будет ли вычисляться статистика и создаваться таблицы атрибутов растра (RAT) для временных растров, созданных с помощью инструментов Spatial Analyst. Параметры среды работают только в интерактивном окне Python приложения. По умолчанию – True.

При установке False статистика будет вычислена для отображения растровых слоев, и будут построены таблицы атрибутов растров.

Boolean
cartographicCoordinateSystem
(чтение и запись)

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

Более подробно о cartographicCoordinateSystem

String
cartographicPartitions
(чтение и запись)

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

Более подробно о cartographicPartitions

String
cellSize
(чтение и запись)

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

Более подробно о cellSize

String
cellSizeProjectionMethod
(чтение и запись)

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

Более подробно о cellSizeProjectionMethod

String
coincidentPoints
(чтение и запись)

Инструменты, использующие параметр среды Совпадающие точки, определяют, как обрабатываются совпадающие данные в Geostatistical Analyst.

Более подробно о coincidentPoints

String
compression
(чтение и запись)

Инструменты, использующие параметр среды Сжатие, будут устанавливать тип сжатия при хранении выходных наборов растровых данных.

Более подробно о compression

String
configKeyword
(чтение и запись)

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

Более подробно о configKeyword

String
daylightSaving
(чтение и запись)

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

Более подробно о daylightSaving

Boolean
extent
(чтение и запись)

Инструменты, использующие параметр среды Экстент, будут обрабатывать только те пространственные объекты или растры, которые находятся в пределах экстента, определенного в этом параметре.

Более подробно о extent

String
geographicTransformations
(чтение и запись)

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

Более подробно о geographicTransformations

String
gpuId
(чтение и запись)

Инструменты, которые используют параметр среды Идентификатор GPU, определяют, какой GPU используется для обработки данных.

Более подробно о gpuId

Long
isCancelled
(только чтение)

Если autoCancelling задано как False, и инструмент отменен, isCancelled будет задано как True. isCancelled имеет значение False по умолчанию и является свойством только для чтения.

Используйте это свойство в инструментах-скриптах и инструментах набора Python.

Более подробно о поведении отмены

Boolean
maintainAttachments
(чтение и запись)

Инструменты, выполняемые с параметром среды Поддержка вложений, копируют вложения из входных объектов в выходные. Будут созданы таблица вложений и класс отношений.

Более подробно о maintainAttachments

Boolean
maintainCurveSegments
(чтение и запись)

Инструменты, использующие параметр среды Поддержка сегментов кривой, будут поддерживать входные сегменты кривой в выходных данных.

Более подробно о maintainCurveSegments

Boolean
maintainSpatialIndex
(чтение и запись)

Прежние версии:

Параметр среды Сохранять пространственный индекс не поддерживается в ArcGIS Pro. Для того, чтобы работать так же, как параметр среды Поддерживать пространственный индекс в ArcGIS Pro при запуске инструментов и рабочих процессов, выполняющих операции вставки, обновления и удаления существующих данных в многопользовательских базах геоданных, управление пространственным индексом может выполняться с помощью инструмента Удалить пространственный индекс, чтобы удалить пространственный индекс до обработки, а затем с помощью инструмента Добавить пространственный индекс, чтобы перестроить пространственный индекс после обработки.

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

Boolean
mask
(чтение и запись)

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

Подробнее о Подробнее о mask

String
matchMultidimensionalVariable
(чтение и запись)

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

Более подробно о matchMultidimensionalVariable

String
MDomain
(чтение и запись)

Инструменты, использующие параметр среды Выходной M домен, будут создавать выходные наборы данных с определенным (m)-доменом измерения.

Более подробно о MDomain

String
MResolution
(чтение и запись)

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

Более подробно о MResolution

Double
MTolerance
(чтение и запись)

Инструменты, использующие этот параметр среды, будут перезаписывать допуск M по умолчанию в наборах геоданных, созданных в базе геоданных.

Более подробно о MTolerance

Double
nodata
(чтение и запись)

Инструменты, имеющие параметр среды NoData, будут обрабатывать только те растры, в которых доступен параметр NoData.

Более подробно о nodata

String
outputCoordinateSystem
(чтение и запись)

Инструменты, использующие параметр среды Выходная система координат, будут создавать выходные наборы геоданных с определенной системой координат.

Более подробно о outputCoordinateSystem

String
outputMFlag
(чтение и запись)

Инструменты, использующие параметр среды Выходные данные содержат M значения, будут управлять наличием M-значений в выходном наборе геоданных.

Более подробно о outputMFlag

String
cellAlignment
(чтение и запись)

Инструменты, использующие параметр среды Выравнивание ячейки, будут настраивать экстент выравнивание ячеек в выходных данных в соответствии с заданным экстентом обработки.

Более подробно о cellAlignment

String
outputZFlag
(чтение и запись)

Инструменты, использующие параметр среды Выходные данные содержат Z значения, будут управлять наличием z-значений в выходном наборе геоданных.

Более подробно о outputZFlag

String
outputZValue
(чтение и запись)

Инструменты, использующие параметр среды Выходное значение Z по умолчанию, будут задавать координату z для каждой выходной вершины, которая не имеет координаты z.

Более подробно о outputZValue

String
overwriteOutput
(чтение и запись)

Задает, будут ли инструменты в процессе их выполнения автоматически перезаписывать имеющиеся выходные данные. Если задано True, инструменты будут выполнены, и выходной набор данных будет перезаписан. Если задано как False, то имеющиеся выходные данные не будут перезаписаны, и инструмент выведет сообщение об ошибке.

Boolean
packageWorkspace
(только чтение)

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

Более подробно о packageWorkspace

String
parallelProcessingFactor
(чтение и запись)

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

Более подробно о parallelProcessingFactor

Integer
processingServer
(чтение и запись)

Инструменты, которые используют набор параметров среды Сервер удаленной обработки, задают сервер, имя пользователя и пароль для ArcGIS Server, когда вы используете параметр среды Коэффициент параллельной обработки.

Имя сервера ArcGIS или IP-адрес, имеющий включенный сервис системы обработки растров. Если Сервером обработки данных является кластер серверов, используйте имя сервера, являющееся хостом сайта.

Более подробно о processingServer

String
processingServerPassword
(чтение и запись)

Инструменты, которые используют набор параметров среды Сервер удаленной обработки, задают сервер, имя пользователя и пароль для ArcGIS Server, когда вы используете параметр среды Коэффициент параллельной обработки.

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

Более подробно о processingServerPassword

String
processingServerUser
(чтение и запись)

Инструменты, которые используют набор параметров среды Сервер удаленной обработки, задают сервер, имя пользователя и пароль для ArcGIS Server, когда вы используете параметр среды Коэффициент параллельной обработки.

Имя пользователя, авторизованного для использования сервиса Raster Processing.

Более подробно о processingServerUser

String
processorType
(чтение и запись)

Инструменты, работающие с параметрами среды Тип процессора, позволяют выбрать, где и как будет происходить обработка данных.

Более подробно о processorType

Long
pyramid
(чтение и запись)

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

Более подробно о pyramid

String
qualifiedFieldNames
(чтение и запись)

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

Более подробно о qualifiedFieldNames

Boolean
randomGenerator
(чтение и запись)

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

Более подробно о randomGenerator

Object
rasterStatistics
(чтение и запись)

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

Более подробно о rasterStatistics

String
recycleProcessingWorkers
(чтение и запись)

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

Более подробно о recycleProcessingWorkers

Long
referenceScale
(чтение и запись)

Инструменты, использующие параметр среды Базовый масштаб, будут рассматривать географический размер и экстент условных обозначений пространственных объектов, по мере их появления в базовом масштабе.

Более подробно о referenceScale

Double
resamplingMethod
(чтение и запись)

Инструменты, которые учитывают параметр среды Метод пересчета, интерполируют значения пикселей при преобразовании набора растровых данных. Он используется, если входные и выходные данные не точно выровнены относительно друг друга, если изменяется размер пиксела, если данные смещаются, или если все это происходит одновременно.

Более подробно о resamplingMethod

String
retryOnFailures
(чтение и запись)

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

Более подробно о retryOnFailures

Long
scratchFolder
(только чтение)

Параметр среды Временная папка является местоположением папки, которую можно использовать для записи файловых данных, например шейп-файлов, текстовых файлов и файлов слоев.

Более подробно о scratchFolder

String
scratchGDB
(только чтение)

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

Более подробно о scratchGDB

String
scriptWorkspace
(только чтение)

Рабочая область скрипта определяет местоположение проекта и используется инструментами геообработки, включенными в пакет проекта (файл .ppkx) и извлеченными из него.

String
scratchWorkspace
(чтение и запись)

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

Более подробно о scratchWorkspace

String
snapRaster
(чтение и запись)

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

Более подробно о snapRaster

String
S100FeatureCatalogueFile
(чтение и запись)

Инструменты, использующие файл каталога объектов S-100, работают с файлом, заданном для соответствия объектов. Атрибутов, классов объектов и отношений при импорте данных и создании схем базы данных.

Более подробно о S100FeatureCatalogueFile

String
terrainMemoryUsage
(чтение и запись)

Инструменты, использующие параметр среды Минимизация использования памяти в процессе анализа на поверхности, контролируют использование памяти в процессе анализа на поверхности.

Более подробно о terrainMemoryUsage

Boolean
tileSize
(чтение и запись)

Инструменты, использующие параметр среды Размер листа (Tile Size), устанавливают размер листа для растров, которые хранятся в блоках данных.

Более подробно о tileSize

String
timeZone
(чтение и запись)

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

Более подробно о timeZone

String
tinSaveVersion
(чтение и запись)

Инструменты, использующие параметр среды Версия хранения TIN по умолчанию, будут выдавать поверхности TIN в заданной версии.

Более подробно о tinSaveVersion

String
transferDomains
(чтение и запись)

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

Более подробно о transferDomains

Boolean
transferGDBAttributeProperties
(чтение и запись)

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

Более подробно о transferGDBAttributeProperties

Boolean
unionDimension
(чтение и запись)

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

Более подробно о unionDimension

Boolean
useCompatibleFieldTypes
(чтение и запись)

Задает, будут ли использоваться типы полей, совместимые с ArcGIS Pro 3.1. Эта настройка относится к типам данных Только дата, Только время, Смещение временной метки и Большое целое в таблицах CSV и незарегистрированных таблицах базы данных при использовании инструментов, которые создают представления слоев или таблиц.

Если установлено значение True, в виде слоя или таблицы, созданном из этих источников, будут использоваться типы полей, совместимые с ArcGIS Pro 3.1. Поля Только дата, Только время и Смещение временной метки будут отображаться как поля даты, а поля типа Большое целое - как тип Double. Если установлено значение False, будут использоваться все типы полей исходного источника данных.

Примечание:

Это свойство применимо при использовании автономного Python или для сервиса геообработки. При использовании ArcGIS Pro, это свойство всегда будет соответствовать опции Использовать типы полей, совместимые с ArcGIS Pro 3.1 и более ранними версиями, при добавлении слоев запросов и текстовых файлов.

Boolean
workspace
(чтение и запись)

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

Более подробно о currentWorkspace

String
XYDomain
(чтение и запись)

Инструменты, использующие параметр среды Выходной XY домен, будут устанавливать определенный диапазон для x,y домена выходного набора геоданных.

Более подробно о XYDomain

String
XYResolution
(чтение и запись)

Инструменты, использующие параметр среды Разрешение XY, будут применять разрешение XY к выходным наборам геоданных. Разрешение X,Y представляет собой очень маленькую величину, соотносящуюся с числом разрядов в цифре координат X,Y.

Более подробно о XYResolution

String
XYTolerance
(чтение и запись)

Инструменты, использующие параметр среды Допуск XY, будут перезаписывать допуск XY по умолчанию в наборах геоданных, созданных в базе геоданных.

Более подробно о XYTolerance

String
ZDomain
(чтение и запись)

Инструменты, использующие параметр среды Выходной домен Z, будут создавать выходные наборы данных с определенным доменом Z.

Более подробно о ZDomain

String
ZResolution
(чтение и запись)

Инструменты, использующие параметр среды Разрешение Z, будут применять разрешение Z к выходным наборам геоданных. Z-разрешение представляет собой очень маленькую величину, соотносящуюся с числом разрядов в цифре координат по Z.

Более подробно о ZResolution

String
ZTolerance
(чтение и запись)

Инструменты, использующие параметр среды Допуск Z, будут перезаписывать допуск Z по умолчанию в наборах геоданных, созданных в базе геоданных.

Более подробно о ZTolerance

String

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