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)