Python ArcGIS optimal_path_as_line用法及代码示例

本文简要介绍 python 语言中 arcgis.raster.analytics.optimal_path_as_line 的用法。

用法:

arcgis.raster.analytics.optimal_path_as_line(input_destination_data, input_distance_accumulation_raster, input_back_direction_raster, destination_field=None, path_type='EACH_ZONE', output_feature_name=None, context=None, create_network_paths='DESTINATIONS_TO_SOURCES', *, gis=None, future=False, **kwargs)

返回：

输出要素图层项目

计算从源到目的地的最佳路径作为特征。 ArcGIS Image Server 10.8.1 及更高版本中可用的函数。

Parameter	Description
input_destination_data	必需的 ImageryLayer 或 FeatureLayer 对象。传送门物品可以通过。一个数据集，用于识别确定到达成本最低来源的最佳路径的位置。 如果输入是栅格，则它必须包含具有目的地有效值的像元，并且必须为其余像元指定 NoData。零是有效值。
input_distance_accumulation_raster	必需的 ImageryLayer 对象。传送门物品可以通过。距离累积栅格用于确定从源到目的地的最佳路径。 距离累积栅格通常使用 distance_accumulation() 或 distance_allocation() 创建。距离累积栅格中的每个像元表示表面上从每个像元到一组源像元的最小累积成本距离。
input_back_direction_raster	必需的 ImageryLayer 对象。传送门物品可以通过。反向栅格包含计算的方向(以度为单位)。该方向确定沿着最佳路径回到最小累积成本源的下一个单元格，同时避免障碍。 值的范围是从 0 度到 360 度，其中 0 保留给源单元格。正东(右)为 90，值顺时针增加(180 为南，270 为西，360 为北)
destination_field	可选字符串。用于获取目标位置值的字段。
path_type	可选字符串。定义输入目标数据上的值和区域将在成本路径计算中解释的方式的关键字。 EACH_ZONE - 对于输入目标数据上的每个区域，确定 least-cost 路径并将其保存在输出栅格上。使用此选项，每个区域的least-cost 路径从区域中成本距离权重最低的像元开始。这是默认设置。 BEST_SINGLE - 对于输入目标数据上的所有单元格，least-cost 路径源自具有最小 least-cost 路径到源单元格的单元格。 EACH_CELL - 对于输入目标数据上具有有效值的每个像元，确定 least-cost 路径并将其保存在输出栅格上。使用此选项，输入目标数据的每个单元格都被单独处理，并为每个来自单元格的 least-cost 路径确定。
output_feature_name	可选的。如果未提供，则由该方法创建要素图层并将其用作输出。 您可以从 GIS 中传入现有要素图层项目以使用它。 或者，您可以传入应通过此方法创建的输出要素图层的名称，以用作工具的输出。如果该名称的服务已经存在，则会引发 RuntimeError
context	可选字典。上下文包含影响任务执行的其他设置。
create_network_paths	可选字符串或布尔值。指定是否计算从目标到源的完整且可能重叠的路径，或者是否创建不重叠的网络路径。 DESTINATIONS_TO_SOURCES(False)：计算从目的地到源的完整路径，该路径可以重叠。这是默认的。 NETWORK_PATHS(真)：计算不重叠的网络路径。 ArcGIS Image Server 10.9 及更高版本中可用的参数。
gis	仅关键字参数。可选的 GIS 对象。如果未指定，则使用当前活动的连接。
future	仅关键字参数。可选的布尔值。如果为 True，则结果将是一个 GPJob 对象，并且结果将异步返回。
folder	仅关键字参数。可选的 str 或 dict。使用给定的文件夹名称在门户中创建一个文件夹(如果不存在)，并将输出保留在此文件夹中。 create_folder() 返回的字典也可以作为输入传入。 例子： {‘username’: ‘user1’, ‘id’: ‘6a3b77c187514ef7873ba73338cf1af8’, ‘title’: ‘trial’}

例子：

# Usage Example 1: To calculate the optimal path from a source to a destination.

destination_data = gis.content.search("my_destination_data")[0].layers[0]
accumulation_raster = gis.content.search("my_accumulation_raster")[0].layers[0]
back_direction_raster = gis.content.search("my_back_direction_raster")[0].layers[0]

optimal_path_op = optimal_path_as_line(input_destination_data=destination_data,
                                       input_distance_accumulation_raster=accumulation_raster,
                                       input_back_direction_raster=back_direction_raster,
                                       output_feature_name="optimal_path_feature",
                                       gis=gis)