Python ArcGIS optimal_region_connections用法及代码示例

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

用法:

arcgis.raster.analytics.optimal_region_connections(input_region_data, input_barrier_data=None, input_cost_raster=None, distance_method='PLANAR', connections_within_regions='GENERATE_CONNECTIONS', output_optimal_lines_name=None, output_neighbor_connections_name=None, context=None, *, gis=None, future=False, **kwargs)

返回：

返回以下作为命名元组 - output_optimum_network_features、output_neighbor_network_features

计算两个或多个输入区域之间的最佳连接网络。 ArcGIS Image Server 10.8.1 及更高版本中可用的函数。

Parameter	Description
input_region_data	必需的 ImageryLayer 或 FeatureLayer 对象。传送门物品可以通过。由最优网络连接的输入区域。 如果区域输入是栅格，则区域由具有相同值的连续(相邻)像元组定义。每个区域必须具有唯一编号。不属于任何区域的像元必须是 NoData。栅格类型必须是整数，并且值可以是正数或负数。 如果区域输入是要素数据集，则它可以是面、线或点。面要素区域不能由多部分面组成。
input_barrier_data	必需的 ImageryLayer 或 FeatureLayer 对象。传送门物品可以通过。定义障碍的数据集。 障碍可以由整数或浮点栅格或要素图层定义。
input_cost_raster	必需的 ImageryLayer 对象。传送门物品可以通过。定义平面移动通过每个像元的阻抗或成本的栅格。 每个单元格位置的值表示移动通过单元格的cost-per-unit 距离。每个像元位置值乘以像元分辨率，同时还补偿对角线移动以获得通过像元的总成本。 成本栅格的值可以是整数或浮点数，但它们不能为负数或零(您不能有负数或零成本)。
distance_method	可选字符串。指定是使用平面(平坦地球)还是测地线(椭球)方法计算距离。 PLANAR - 距离计算将使用 2D 笛卡尔坐标系在投影平面上执行。这是默认设置。 GEODESIC - 距离计算将在椭球体上执行。因此，无论输入或输出投影，结果都不会改变。
connections_within_regions	可选字符串。默认 - GENERATE_CONNECTIONS 可能的选项：GENERATE_CONNECTIONS、NO_CONNECTIONS
output_optimal_lines_name	可选的。如果未提供，则由该方法创建要素图层并将其用作输出。您可以从 GIS 中传入现有要素图层项目以使用它。或者，您可以传入应通过此方法创建的输出要素图层的名称，以用作工具的输出。如果该名称的服务已经存在，则会引发 RuntimeError 这是连接每个输入区域所需的最佳路径网络的输出折线要素类。 每条路径(或行)都有唯一编号，属性表中的附加字段存储有关路径的特定信息。这些字段如下： PATHID - 路径的唯一标识符 PATHCOST - 路径的总累积距离或成本 REGION1 - 路径连接的第一个区域 REGION2 - 路径连接的另一个区域 此信息提供对网络内路径的深入了解。 由于每条路径都由一条唯一的线表示，因此在路径经过相同路线的位置会有多条线。
output_neighbor_connections_name	可选的。如果未提供，则由该方法创建要素图层并将其用作输出。您可以从 GIS 中传入现有要素图层项目以使用它。或者，您可以传入应通过此方法创建的输出要素图层的名称，以用作工具的输出。如果该名称的服务已经存在，则会引发 RuntimeError 这是输出折线要素类，用于标识从每个区域到每个最近邻域或成本邻域的所有路径。 每条路径(或行)都有唯一编号，属性表中的附加字段存储有关路径的特定信息。这些字段如下： PATHID - 路径的唯一标识符 PATHCOST - 路径的总累积距离或成本 REGION1 - 路径连接的第一个区域 REGION2 - 路径连接的另一个区域 此信息提供对网络内路径的深入了解，并且在决定在必要时应删除哪些路径时特别有用。 由于每条路径都由一条唯一的线表示，因此在路径经过相同路线的位置会有多条线。
context	上下文包含影响任务执行的其他设置。
gis	可选的 GIS 对象。如果未指定，则使用当前活动的连接。
future	仅关键字参数。可选的布尔值。如果为 True，则结果将是一个 GPJob 对象，并且结果将异步返回。
folder	仅关键字参数。可选的 str 或 dict。使用给定的文件夹名称在门户中创建一个文件夹(如果不存在)，并将输出保留在此文件夹中。 gis.content.create_folder 返回的字典也可以作为输入传入。 例子： {‘username’: ‘user1’, ‘id’: ‘6a3b77c187514ef7873ba73338cf1af8’, ‘title’: ‘trial’}

例子：

# Usage Example 1: To calculate the optimal connections between regions.

region_data = gis.content.search("my_region_data")[0].layers[0]
barrier_data = gis.content.search("my_barrier_data")[0].layers[0]
cost_raster = gis.content.search("my_cost_raster")[0].layers[0]

optimal_region_op = optimal_region_connections(input_region_data=region_data,
                                               input_barrier_data=barrier_data,
                                               input_cost_raster=cost_raster,
                                               output_optimal_lines_name="optimal_lines_feature",
                                               output_neighbor_connections_name="optimal_region_feature",
                                               gis=gis)