env
汇总
环境设置 显示为 env 类上的属性。 可将地理处理环境设置视为影响工具执行结果的附加参数。
讨论
自 ArcGIS Pro 2.9 起，设置无效环境名称将失败，并出现 AttributeError 异常。
属性
| 名称 | 说明 | 数据类型 |
|---|---|---|
|
addOutputsToMap （读取和写入） |
指定输出数据集是否将添加到应用程序显示。 此属性仅当直接在 Python 窗口或 ArcGIS Pro 中的笔记本中使用时才适用。 |
Boolean |
|
annotationTextStringFieldLength （读取和写入） |
支持“注记文本字符串字段长度”环境的工具将覆盖在数据库中创建的任何注记要素类中 |
Long |
|
autoCancelling （读取和写入） |
指定取消是否会在当前行结束脚本。 如果 用于脚本工具或 Python 工具箱工具。 |
Boolean |
|
autoCommit （读取和写入） |
支持“自动提交”环境的工具将在企业级地理数据库事务中进行指定次数的更改后强制执行提交。 |
Long |
|
baDataSource （读取和写入） |
支持数据源环境的工具使用分析期间指定的 Business Analyst 数据集中的变量和网络数据。 此环境仅由 Business Analyst 工具使用。 |
String |
|
baNetworkSource （读取和写入） |
支持网络源环境的工具在处理过程中使用选定网络数据集中的街道和其他数据。 仅供 Business Analyst 工具使用。 |
String |
|
baUseDetailedAggregation （读取和写入） |
支持“使用详细聚合”环境的工具在分配数据时将采用以下两种策略：尽可能提高精度但性能降低，或者提高性能但降低精度。 此环境仅由 Business Analyst 工具使用。 |
Boolean |
|
baUseSegmentNames （读取和写入） |
支持“显示细分名称”环境的工具将使用此设置以在目标营销工作流和报告模板中包含或移除细分名称。 此环境仅供 Business Analyst 工具使用。 例如， 仅显示 ID 设置将显示 8A，而非 8A City Lights。 |
String |
|
buildStatsAndRATForTempRaster （读取和写入） |
指定是否为 Spatial Analyst 工具创建的临时栅格计算统计数据和构建栅格属性表 (RAT)。 buildStatsAndRATForTempRaster 环境仅在应用程序内的交互式 Python 窗口中使用。 默认值为 如果设置为 |
Boolean |
|
cartographicCoordinateSystem （读取和写入） |
支持“制图坐标系”环境的工具将使用指定的坐标系来确定进行计算时要素的大小、范围和空间关系。 |
String |
|
cartographicPartitions （读取和写入） |
采用 Cartographic Partitions 环境的工具将通过指定的分区面要素细分输入要素，以便按顺序处理，从而避免处理大型数据集时可能遇到的内存限制。 |
String |
|
cellSize （读取和写入） |
支持“像元大小”环境的工具可以设置在操作时使用的输出栅格像元大小或分辨率。 默认输出分辨率将由输入栅格数据集中最粗糙的输入确定，除非由工具确定。 |
String |
|
cellSizeProjectionMethod （读取和写入） |
在分析期间投影数据集时，支持“像元大小投影方法”环境的工具将使用指定的方法计算输出栅格像元大小。 |
String |
|
coincidentPoints （读取和写入） |
支持“重合点”环境的工具可以定义如何在 Geostatistical Analyst 中处理重合数据。 |
String |
|
compression （读取和写入） |
支持“压缩”环境的工具将在存储输出栅格数据集时设置压缩类型 |
String |
|
configKeyword （读取和写入） |
支持“输出配置关键字”环境的工具在地理数据库中创建数据集时将使用指定的关键字。 |
String |
|
curveProcessingMethod （读取和写入） |
支持“曲线处理方法”环境的工具，可以在 保留曲线段 环境中使用曲线处理方法，以指定输入曲线段是作为真曲线还是作为代表曲线要素的一组线性段在内部进行处理。 |
String |
|
daylightSaving （读取和写入） |
支持“按夏令时调整”环境的工具可调整日期字段的时区值以考虑夏令时。 |
Boolean |
|
extent （读取和写入） |
支持“范围”环境的工具仅处理与指定范围相交的要素或栅格。 |
String |
|
geographicTransformations （读取和写入） |
支持“地理（坐标）变换”环境的工具将在投影数据时使用变换方法。 |
String |
|
gpuId （读取和写入） |
支持“GPU ID”环境的工具可标识用于处理数据的 GPU。 |
Long |
|
isCancelled （只读） |
如果 在脚本工具或 Python 工具箱工具中使用此属性。 |
Boolean |
|
maintainAttachments （读取和写入） |
支持维护附件环境的工具可将附件从输入要素复制到输出要素中。 将创建附件表和关系类。 |
Boolean |
|
maintainCurveSegments （读取和写入） |
支持“保留曲线段”环境的工具将在输出中保留输入曲线段。 |
Boolean |
|
maintainSpatialIndex （读取和写入） |
Boolean |
|
|
mask （读取和写入） |
支持“掩膜”环境的工具只会考虑运行过程中落入分析掩膜范围内的像元。 |
String |
|
matchMultidimensionalVariable （读取和写入） |
仅当输入多维栅格共享至少一个具有相同名称的变量时，支持“匹配多维变量”环境的工具才会生成多维栅格。 |
String |
|
MDomain （读取和写入） |
遵循“输出 M 属性域”环境的工具将生成具有指定测量属性域（m 属性域）的输出数据集。 |
String |
|
MResolution （读取和写入） |
支持“M 分辨率”环境的工具可将 M 分辨率应用到输出地理数据集中。 M 分辨率（表示非常小的距离）是指用于存储 M 值的有效数字的位数。 |
Double |
|
MTolerance （读取和写入） |
支持“M 容差”环境的工具工具会覆盖在地理数据库中创建的地理数据集上的默认 M 容差。 |
Double |
|
nodata （读取和写入） |
支持 NoData 环境的工具将仅处理其中 NoData 值有效的栅格。 |
String |
|
outputCoordinateSystem （读取和写入） |
支持输出坐标系环境的工具将使用指定坐标系创建输出地理数据集。 |
String |
|
outputMFlag （读取和写入） |
遵循“输出包含 M 值”环境的工具将控制地理数据集是否存储 m 值。 |
String |
|
cellAlignment （读取和写入） |
支持“像元对齐方式”环境的工具将调整输出的像元对齐方式，以与指定处理范围的像元对齐方式一致。 |
String |
|
outputZFlag （读取和写入） |
支持“输出包含 Z 值”环境的工具将控制地理数据集是否存储 Z 值。 |
String |
|
outputZValue （读取和写入） |
支持“默认输出 Z 值”环境的工具可为每个尚不具有 z 坐标的输出折点设置 z 坐标。 |
String |
|
overwriteOutput （读取和写入） |
指定工具在运行时是否自动覆盖任何现有输出。 设置为 |
Boolean |
|
overwriteOutputOptions （读取和写入） |
当
|
String |
|
packageWorkspace （只读） |
包工作空间环境设置是用于定位所共享的地理处理包或服务内容的文件夹所处的位置。 |
String |
|
parallelProcessingFactor （读取和写入） |
支持并行处理因子环境的工具将跨多个进程分隔并执行操作。 |
Integer |
|
processingServer （读取和写入） |
启用栅格处理系统服务的 ArcGIS 服务器名称或 IP 地址。 如果使用 并行处理因子 环境，则支持“远程处理服务器”环境集的工具将为 ArcGIS Server 指定服务器、用户名和密码。 |
String |
|
processingServerPassword （读取和写入） |
与获得使用栅格处理服务权限的用户名关联的密码。 如果使用 并行处理因子 环境，则支持“远程处理服务器”环境集的工具将为 ArcGIS Server 指定服务器、用户名和密码。 |
String |
|
processingServerUser （读取和写入） |
获得使用栅格处理服务权限的用户名。 如果使用 并行处理因子 环境，则支持“远程处理服务器”环境集的工具将为 ArcGIS Server 指定服务器、用户名和密码。 |
String |
|
processorType （读取和写入） |
您可通过支持“处理器类型”环境的工具来选择您希望用来处理数据的位置和方式。 |
Long |
|
pyramid （读取和写入） |
支持“金字塔”环境的工具将仅处理金字塔有效的栅格。 ERDAS IMAGINE 文件的金字塔可以设置的选项有限。 |
String |
|
qualifiedFieldNames （读取和写入） |
支持“维护全限定的字段名”环境的工具将使用此设置来区分限定的字段名和未限定的字段名。 限定的字段名是要素类或表中的这样一些字段名称，在它们的字段名称后会附加原始要素类或表的名称。 使用连接数据时，会涉及此设置。 |
Boolean |
|
randomGenerator （读取和写入） |
使用“随机数生成器”环境的工具将通过利用种子和分布的各种算法来生成一系列随机数。 |
Object |
|
rasterStatistics （读取和写入） |
支持“栅格统计数据”环境的工具可控制为输出栅格数据集构建统计数据的方式。 |
String |
|
recycleProcessingWorkers （读取和写入） |
支持“处理工作线程的周期间隔”环境的工具定义在重新启动工作进程之前将处理的影像部分数量，以防止运行时间较长的进程中可能出现故障。 |
Long |
|
referenceScale （读取和写入） |
依据“参考比例”环境的工具根据符号化要素在参考比例的显示情况设置其图形大小和范围。 |
Double |
|
resamplingMethod （读取和写入） |
支持重采样方法环境的工具在转换栅格数据集时会插值像素值。 在以下情况使用：输入和输出排列不对应、像素大小发生变化、数据被平移或以上原因的综合。 |
String |
|
retryOnFailures （读取和写入） |
当处理特定作业失败时，支持“针对故障的重试次数”环境的工具将重试同一工作进程指定的尝试次数。 |
Long |
|
scratchFolder （只读） |
“临时文件夹”环境设置是一个文件夹位置，可用来写入基于文件的数据（如 shapefile、文本文件和图层文件）。 |
String |
|
scratchGDB （只读） |
“临时 GDB”环境设置是可以用来写入临时数据的文件地理数据库的位置。 |
String |
|
scriptWorkspace （只读） |
“脚本工作空间”是工程的位置，如果地理处理工具已包含在工程包（ |
String |
|
scratchWorkspace （读取和写入） |
支持“临时工作空间”环境的工具可将指定的位置用作输出数据集的默认工作空间。 "临时工作空间"用于存放您不希望保留的输出数据。 |
String |
|
snapRaster （读取和写入） |
支持“捕捉栅格”环境的工具将调整输出栅格的范围，以使它们的像元对齐方式与指定的捕捉栅格的像元对齐方式相匹配。 |
String |
|
S100FeatureCatalogueFile （读取和写入） |
支持 S-100“要素目录文件”环境的工具，在数据导入以及创建数据库方案期间使用指定的文件来映射对象、属性、要素类和关系。 |
String |
|
terrainMemoryUsage （读取和写入） |
支持针对 terrain 环境在进行分析时使用最小内存的工具将控制对 terrain 进行分析时的内存使用情况。 |
Boolean |
|
tileSize （读取和写入） |
支持“分块大小”环境的工具用于为存储在数据块中的栅格设置分块大小。 |
String |
|
timeZone （读取和写入） |
支持时区环境的工具将指定存储日期字段的时区。 |
String |
|
tinSaveVersion （读取和写入） |
遵循默认 TIN 存储版本环境的工具将输出指定版本的 TIN 表面。 |
String |
|
transferDomains （读取和写入） |
依照传递字段属性域描述环境的工具，其用于控制输出是否包括包含属性域和子类型描述的字段，以及包含属性域和子类型代码的字段。 当地理处理工具的输入是定义了属性域和子类型的地理数据库要素类或表时，此设置才相关。 |
Boolean |
|
transferGDBAttributeProperties （读取和写入） |
支持“传输地理数据库字段属性”环境的工具会将属性域、子类型、属性规则、字段组和条件值从输入数据集的字段传输到输出数据集的字段。 |
Boolean |
|
unionDimension （读取和写入） |
支持“并集维度”环境的工具将生成一个多维栅格，其中包含来自输入多维栅格的所有维度。 |
Boolean |
|
useCompatibleFieldTypes （读取和写入） |
指定是否使用与 ArcGIS Pro 3.1 兼容的字段类型。 此设置关于 CSV 表和未注册的数据库表中的仅日期、仅时间、时间戳偏移和大整型字段类型在创建图层或表视图的工具中的使用。 当设置为 注:此属性适用于独立 Python 或地理处理服务。 在 ArcGIS Pro 中使用时，此属性始终与 添加查询图层和文本文件时使用与 ArcGIS Pro 3.1 及更早版本兼容的字段类型 选项一致。 |
Boolean |
|
workspace （读取和写入） |
支持“当前工作空间”环境的工具将指定的工作空间用作地理处理工具输入和输出的默认位置。 |
String |
|
XYDomain （读取和写入） |
支持“输出 XY 值域”环境的工具可为输出地理数据集的 x,y 值域设置特定范围。 |
String |
|
XYResolution （读取和写入） |
支持“XY 分辨率”环境的工具可将 x,y 分辨率应用到输出地理数据集中。 x,y 分辨率（表示非常小的距离）是指用于存储 x,y 坐标值的有效数字的位数。 |
String |
|
XYTolerance （读取和写入） |
支持“XY 容差”环境的工具会覆盖在地理数据库内创建的地理数据集上的默认 x,y 容差。 |
String |
|
ZDomain （读取和写入） |
支持“输出 Z 值域”环境的工具将生成带有指定 z 值域的输出数据集。 |
String |
|
ZResolution （读取和写入） |
支持“Z 分辨率”环境的工具可将 z 分辨率应用到输出地理数据集中。 z 分辨率（表示非常小的距离）是指用于存储 z 坐标值的有效数字的位数。 |
String |
|
ZTolerance （读取和写入） |
支持“Z 容差”环境的工具会覆盖在地理数据库内创建的地理数据集上的默认 z 容差。 |
String |