摘要
环境设置显示为 env 类上的属性。 可将地理处理环境设置视为影响工具执行结果的附加参数。
说明
自 ArcGIS Pro 2.9 起，设置无效环境名称将失败，并出现 AttributeError 异常。
属性
| 属性 | 说明 | 数据类型 |
| addOutputsToMap (可读写) | 指定输出数据集是否将添加到应用程序显示。 此属性仅当直接在 Python 窗口或 ArcGIS Pro 中的笔记本中使用时才适用。 | Boolean |
| annotationTextStringFieldLength (可读写) | 支持注记文本字符串字段长度环境的工具将覆盖数据库中创建的所有注记要素类中 TextString 字段的默认字段长度。 | Long |
| autoCancelling (可读写) | 指定取消是否会在当前行结束脚本。 如果 True，则取消将结束脚本。 如果设置为 False，则取消会将 isCancelled 属性设置为 True，然后继续运行。 默认为 True。 用于脚本工具或 Python 工具箱工具。 | Boolean |
| autoCommit (可读写) | 支持“自动提交”环境的工具将在企业级地理数据库事务中进行指定次数的更改后强制执行提交。 | Long |
| baDataSource (可读写) | 支持“数据源”环境的工具采用在图层之间汇总数据的方式。 此环境仅由 Business Analyst 工具使用。 | String |
| baNetworkSource (可读写) | 支持网络源环境的工具可用于设置用于网络距离计算任务的网络数据集或服务。仅由 Business Analyst 工具使用。 | String |
| baUseDetailedAggregation (可读写) | 支持“使用详细聚合”环境的工具将对超出指定半径的区域使用详细数据聚合方法。 此环境仅由 Business Analyst 工具使用。 | Boolean |
| buildStatsAndRATForTempRaster (可读写) | 指定是否为 Spatial Analyst 工具创建的临时栅格计算统计数据和构建栅格属性表 (RAT)。 该环境仅在应用程序内的交互式 Python 窗口中使用。 默认为 True。 如果设置为 False，则考虑到符号化栅格图层的目的，统计数据将为近似值，并且将不会构建 RAT。 | Boolean |
| cartographicCoordinateSystem (可读写) | 支持“制图坐标系”环境的工具将使用指定的坐标系来确定进行计算时要素的大小、范围和空间关系。 | String |
| cartographicPartitions (可读写) | 采用制图分区环境的工具将通过指定的分区面要素细分输入要素，以便按顺序处理，从而避免处理大型数据集时可能遇到的内存限制。 | String |
| cellSize (可读写) | 支持“像元大小”环境的工具可以设置在操作时使用的输出栅格像元大小或分辨率。 默认输出分辨率将由输入栅格数据集中最粗糙的输入确定。 | String |
| cellSizeProjectionMethod (可读写) | 在分析期间投影数据集时，支持“像元大小投影方法”环境的工具将使用指定的方法计算输出栅格像元大小。 | String |
| coincidentPoints (可读写) | 支持“重合点”环境的工具可以定义如何在 Geostatistical Analyst 中处理重合数据。 | String |
| compression (可读写) | 支持“压缩”环境的工具将在存储输出栅格数据集时设置压缩类型 | String |
| configKeyword (可读写) | 支持“输出配置关键字”环境的工具在地理数据库中创建数据集时将使用指定的关键字。 | String |
| daylightSaving (可读写) | 支持“按夏令时调整”环境的工具可调整日期字段的时区值以考虑夏令时。 | Boolean |
| extent (可读写) | 支持“范围”环境的工具仅处理位于此设置中所指定范围内的要素或栅格。 | String |
| geographicTransformations (可读写) | 支持“地理（坐标）变换”环境的工具将在投影数据时使用变换方法。 | String |
| gpuId (可读写) | 支持“GPU ID”环境的工具可标识用于处理数据的 GPU。 | Long |
| isCancelled (只读) | 如果 autoCancelling 设置为 False 并且已取消工具，则 isCancelled 将设置为 True。默认情况下，isCancelled 为 False，且为只读属性。 在脚本工具或 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 (可读写) | 指定工具在运行时是否自动覆盖任何现有输出。 设置为 True 时，工具将运行并覆盖输出数据集。 设置为 False 时，将不会覆盖现有输出，工具将返回错误。 | Boolean |
| 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 (只读) | “脚本工作空间”是工程的位置，如果地理处理工具已包含在工程包（.ppkx 文件）中并已提取时，将使用“脚本工作空间”。 | 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 表和未注册的数据库表中的仅日期、仅时间、时间戳偏移和大整型字段类型在创建图层或表视图的工具中的使用。 当设置为 True 时，通过这些源创建的图层或表视图将使用与 ArcGIS Pro 3.1 兼容的字段类型。 仅日期、仅时间和时间戳偏移字段将显示为日期字段，大整型字段将显示为双精度字段。 当设置为 False 时，将使用所有原始数据源字段类型。 注：此属性适用于独立 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 |