Python ArcGIS summarize_raster_within用法及代码示例

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

用法:

arcgis.raster.analytics.summarize_raster_within(input_zone_layer, input_raster_layer_to_summarize, zone_field='Value', statistic_type='Mean', ignore_missing_values=True, output_name=None, context=None, process_as_multidimensional=False, percentile_value=90, percentile_interpolation_type='AUTO_DETECT', circular_calculation=False, circular_wrap_value=360, *, gis=None, future=False, **kwargs)

返回：

根据第一个输入图层 (input_zone_layer) 定义的区域(区域)汇总栅格。

Parameter	Description
input_zone_layer	所需图层 - 用于汇总定义边界内的栅格图层的区域图层。 定义要汇总的区域或区域边界的图层。 图层可以是栅格或要素数据。对于栅格，区域由输入中的所有位置定义
input_raster_layer_to_summarize	必需 - 要汇总的栅格图层。 该图层中的栅格单元将按它们所在的区域(区域)进行汇总。
zone_field	必需的字符串 - 定义边界的字段。这是用于定义区域边界的图层属性。例如，假设第一个输入图层定义了管理单元边界，其属性定义了每个单元的区域、地区和宗地 ID。您还有一个栅格图层，为每个位置定义生物多样性 index 。使用您选择的字段，您可以决定计算地方、地区或区域级别的平均生物多样性。 默认值：“Value”
statistic_type	可选字符串 - 要计算的统计信息。您可以计算输入区域图层中点、线或区域的任何数值属性的统计数据。 statistic_type 可以是以下之一：['Mean', 'Majority', 'Maximum', 'Median', 'Minimum', 'Minority', 'Range', 'STD', 'SUM', 'Variety' , '百分位数'] 平均值：计算值栅格中与输出像元属于同一区域的所有像元的平均值。这是默认设置。 多数：确定值栅格中与输出像元属于同一区域的所有像元的多数值。 最大值：确定值栅格中与输出像元属于同一区域的所有像元的最大值。 中值：查找值栅格中与输出像元属于同一区域的所有像元的中值。 最小值：查找值栅格中与输出像元属于同一区域的所有像元中的最小值。 Minority：确定值栅格中与输出像元属于同一区域的所有像元的少数值。 范围：查找值中与输出区域属于同一区域的所有单元格的范围。 总和：将值栅格中与输出像元属于同一区域的所有像元的总值相加。 STD：查找值栅格中与输出像元属于同一区域的所有像元的标准差。 品种：查找值栅格中与输出像元属于同一区域的所有像元的品种。 百分位数：查找值栅格中与输出像元属于同一区域的所有像元的百分位数。默认情况下计算第 90 个百分位数。您可以使用 percentile_value 参数指定其他值(从 0 到 100)。 如果input_raster_layer_to_summarize 为浮点类型，则无法计算多数、中位数、平均值和品种的区域计算。
ignore_missing_values	可选布尔值，如果您选择忽略缺失值，则只有在要汇总的图层中具有值的单元格才会用于确定该区域的输出值。否则，如果某个区域的任何地方都存在缺失值，则认为没有足够的信息对该区域中的所有像元进行统计计算，并且该区域将在输出中收到空值(NoData)。
output_name	可选的。如果未提供，则由该方法创建影像服务并将其用作输出栅格。您可以从 GIS 中传入现有的影像服务项目来使用它。或者，您可以传入应通过此方法创建的输出图像服务的名称，以用作工具的输出。如果该名称的服务已经存在，则会引发 RuntimeError
context	context 包含影响任务执行的其他设置。 context 参数覆盖通过arcgis.env 参数设置的值 此函数具有以下设置： Extent(范围)：定义分析区域的边界框。 例子： {“extent”: {“xmin”: -122.68, “ymin”: 45.53, “xmax”: -122.45, “ymax”: 45.6, “spatialReference”: {“wkid”: 4326}}} 输出空间参考 (outSR)：输出栅格将投影到输出空间参考中。 例子： {“outSR”: {spatial reference}} 捕捉栅格 (snapRaster)：输出栅格的像元将与指定的捕捉栅格对齐。 例子： {‘snapRaster’: {‘url’: ‘<image_service_url>’}} 掩码(mask)：在操作中只考虑落在分析掩码内的单元格。 例子： {“mask”: {“url”: “<image_service_url>”}} 像元大小(cellSize)：输出栅格将具有由像元大小指定的分辨率。 例子： {‘cellSize’: 11} or {‘cellSize’: {‘url’: <image_service_url>}} or {‘cellSize’: ‘MaxOfIn’} 重采样方法(resamplingMethod)：输出栅格将被重采样到指定的方法。支持的值是：双线性、最近、三次。 例子： {‘resamplingMethod’: “Nearest”}
process_as_multidimensional	可选布尔值，如果设置为 True，则处理为多维，如果输入是多维栅格。 True - 将从多维影像服务的当前切片计算统计数据。这是默认设置。 False - 将为多维影像服务的所有维度(例如时间或深度)计算统计信息。 ArcGIS Image Server 10.8.1 及更高版本中可用的参数。
percentile_value	可选 Double，要计算的百分位数。默认值为 90，即第 90 个百分位数。这些值的范围可以从 0 到 100。第 0 个百分位本质上等同于最小统计量，第 100 个百分位等同于最大值。值 50 将产生与中位数统计量基本相同的结果。 仅当 statistics_type 参数设置为百分位数时，此参数才可用。 ArcGIS Image Server 10.8.1 及更高版本中可用的参数。
percentile_interpolation_type	可选的字符串。指定当指定的百分位值位于两个输入像元值之间时要使用的插值方法。 AUTO_DETECT - 如果输入值栅格具有整数像素类型，则使用 NEAREST 方法。如果输入值栅格具有浮点像素类型，则使用 LINEAR 方法。这是默认设置。 NEAREST - 与所需百分位数最近的值。在这种情况下，输出像素类型与输入值栅格的像素类型相同。 LINEAR - 来自所需百分位数的两个周围值的加权平均值。在这种情况下，输出像素类型是浮点数。 ArcGIS Image Server 10.9 及更高版本中可用的参数。
circular_calculation	可选布尔值。表示统计计算是算术计算还是循环计算。 False - 计算算术统计数据。这是默认设置。 True - 计算适合循环量的循环统计数据，例如罗盘方向(以度为单位)、白天和实数的小数部分。 ArcGIS Image Server 11 及更高版本中可用的参数。
circular_wrap_value	可选浮点数。循环数据中可能的最高值(上限)。它是一个正数，默认为 360。该值也表示与可能的最低值(下界)相同的数量。仅当 circular_calculation 参数设置为 True 时，才会使用此参数。 ArcGIS Image Server 11 及更高版本中可用的参数。
gis	可选的 GIS 对象。如果未指定，则使用当前活动的连接。
future	仅关键字参数。可选的布尔值。如果为 True，则结果将是一个 GPJob 对象，并且结果将异步返回。
folder	仅关键字参数。可选的 str 或 dict。使用给定的文件夹名称在门户中创建一个文件夹(如果不存在)，并将输出保留在此文件夹中。 create_folder() 返回的字典也可以作为输入传入。 例子： {‘username’: ‘user1’, ‘id’: ‘6a3b77c187514ef7873ba73338cf1af8’, ‘title’: ‘trial’}
tiles_only	仅关键字参数。可选的布尔值。在ArcGIS Online 中，此函数的默认输出影像服务将是平铺影像图层。 要在 ArcGIS Online 上创建动态影像图层作为输出，请将 tiles_only 参数设置为 False。 函数将不支持ArcGIS Enterprise 中的tiles_only 参数，默认情况下会生成动态影像图层。

output_raster：影像图层项目

例子：

# Usage Example 1: Summarizes raster based on the input zone layer.

zone_layer = gis.content.search("zone_lyr")[0].layers[0]
raster_inp = gis.content.search("raster_inp_lyr")[0].layers[0]

summarize1 = summarize_raster_within(input_zone_layer=zone_layer,
                                     input_raster_layer_to_summarize=raster_inp,
                                     zone_field="Value",
                                     gis=gis)

# Usage Example 2: Summarizes raster based on the multidimensional input zone layer.

multi_zone_layer = gis.content.search("multi_zone_lyr")[0].layers[0]
raster_inp = gis.content.search("raster_inp_lyr")[0].layers[0]

summarize2 = summarize_raster_within(input_zone_layer=multi_zone_layer,
                                     input_raster_layer_to_summarize=raster_inp,
                                     zone_field="Value",
                                     process_as_multidimensional=True
                                     gis=gis)