从指定的多边形中提取输入要素。
使用裁剪图层来裁剪点、线或面要素。
此工具用于以其他要素类中的一个或多个要素作为模具来剪切要素类的一部分。在您想要创建一个包含另一较大要素类的地理要素子集的要素类（也称为研究区域或感兴趣区域 (AOI)）时，此工具尤为有用。
分析将裁剪覆盖感兴趣区域的要素或要素的各部分。
输出结果将包含叠加裁剪图层面的输入图层要素。
输出几何类型将与裁剪的输入要素相同。例如，如果在面内裁剪线要素，则输出结果将为线。
输入图层参数中的所有字段都将包含在输出结果中。来自裁剪图层参数的字段将不包含在输出中。
您可以执行以下其中一个或两个操作来提高裁剪图层工具的性能。
此地理处理工具由 ArcGIS GeoAnalytics Server 作为支持。分析将在 GeoAnalytics Server 上完成，且结果将存储在 ArcGIS Enterprise 的内容中。
当 GeoAnalytics Server 工具运行时，GeoAnalytics Server 上的分析已完成。要获得最佳性能，通过 ArcGIS Enterprise 门户上托管的要素图层或通过大数据文件共享，可以将数据用于 GeoAnalytics Server。在分析开始之前，非 GeoAnalytics Server 本地数据将被转移到您的 GeoAnalytics Server。这意味着运行工具需要更长时间，并且在某些情况下，从 ArcGIS Pro 到 GeoAnalytics Server 移动数据可能会失败。失败的阈值取决于网络速度，以及数据的大小和复杂性。因此，建议您始终共享数据或创建大数据文件共享。
| 标注 | 说明 | 数据类型 |
输入图层
| 包含要进行缓冲的点、线或面要素的数据集。 | Feature Set |
裁剪图层 | 包含用于剪切输入要素的面要素的数据集。 | Feature Set |
输出名称
(可选) | 输出要素服务的名称。 | String |
Data Store
(可选) | 指定将用于保存输出的 ArcGIS Data Store。默认设置为时空大数据存储。在时空大数据存储中存储的所有结果都将存储在 WGS84 中。在关系数据存储中存储的结果都将保持各自的坐标系。
| String |
| 标注 | 说明 | 数据类型 |
| 输出要素类 | 裁剪输出结果。 | 要素集 |
arcpy.geoanalytics.ClipLayer(input_layer, clip_layer, {output_name}, {data_store})| 名称 | 说明 | 数据类型 |
input_layer | 包含要进行缓冲的点、线或面要素的数据集。 | Feature Set |
clip_layer | 包含用于剪切输入要素的面要素的数据集。 | Feature Set |
output_name (可选) | 输出要素服务的名称。 | String |
data_store (可选) | 指定将用于保存输出的 ArcGIS Data Store。默认为 SPATIOTEMPORAL_DATA_STORE。在时空大数据存储中存储的所有结果都将存储在 WGS84 中。在关系数据存储中存储的结果都将保持各自的坐标系。
| String |
| 名称 | 说明 | 数据类型 |
| output | 裁剪输出结果。 | 要素集 |
以下 Python 脚本演示了如何使用 ClipLayer 工具。
#-------------------------------------------------------------------------------
# Name: ClipLayer.py
# Description: Clip USA Rivers to the extent of state boundaries.
# Results can be found in your Portal
# Requirements: ArcGIS GeoAnalytics Server
# Import system modules
import arcpy
# Set local variables
clipFeatures = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA_Rivers/FeatureServer/0"
studyArea = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Nebraska_Boundary/FeatureServer/0"
outFS = "NebraskaRivers"
dataStore = "RELATIONAL_DATA_STORE"
# Execute Clip Layer
arcpy.geoanalytics.ClipLayer(clipFeatures, studyArea, outFS, dataStore)将用于分析的坐标系。除非由该参数进行指定，否则将基于输入坐标系完成分析。对于 GeoAnalytics Tools，最终结果将存储于 WGS84 中的时空数据存储之内。