Python ArcGIS sample用法及代碼示例

本文簡要介紹 python 語言中 arcgis.raster.analytics.sample 的用法。

用法:

arcgis.raster.analytics.sample(input_rasters, input_location_data, resampling_type='NEAREST', unique_id_field=None, acquisition_definition=None, statistics_type='MEAN', percentile_value=None, buffer_distance=None, layout='ROW_WISE', generate_feature_class=False, process_as_multidimensional=None, output_name=None, context=None, *, gis=None, future=False, **kwargs)

返回：

FeatureLayer 或 Table 對象

函數創建一個表格，顯示一個柵格或一組柵格中定義位置的像元值。這些位置由柵格單元、麵要素、折線要素或一組點定義。輸入柵格可以是二維的或多維的。當輸入柵格為多維時，輸出表的結構會發生變化。 ArcGIS Image Server 10.8.1 及更高版本中可用的函數。

Parameter	Description
input_rasters	ImageryLayer 對象所需的列表。可以傳遞門戶項目列表。
input_location_data	必需的 ImageryLayer 或 FeatureLayer 對象。識別您想要采樣的位置的數據。當上下文中 processAsMultiDimension 設置為 True 時，支持折線和麵要素服務。
resampling_type	可選的字符串。對柵格進行采樣時使用的重采樣算法。 NEAREST：最近鄰分配。這是默認設置。 BILINEAR：雙線性插值 CUBIC：三次卷積 例子： “NEAREST”
unique_id_field	可選的整數。對於輸入位置柵格或點要素中的每個位置或要素，包含不同值的字段。 例子： “FID”
acquisition_definition	可選字典。指定與位置特征相關的時間、深度或其他采集數據。 僅支持以下組合： 維度 + 起始字段或值 維度 + 起始字段或值 + 結束字段或值 維度 + 起始字段或值 + 相對值或前幾天 + 相對值或後幾天 相對值或天數之前和相對值或天數之後僅支持非負值。 將針對該維度範圍內的變量計算統計數據。 語法：字典對象的列表。 [{“dimension”: “Dimension”, “startFieldOrVal”: “Start field or value”, “endFieldOrVal”: “End field or value”, “relValOrDaysBefore”: “Relative value or days before”, “relValOrDaysAfter”: “Relative value or days after”}] 例子： [{“dimension”: “Dimension”, “startFieldOrVal”: “1999-01-01T00:00:00”, “endFieldOrVal”: “2019-01-01T00:00:00”}]
statistics_type	可選字符串。要計算的統計類型。 MINIMUM - 找出指定範圍內的最小值。 MAXIMUM - 查找指定範圍內的最大值。 MEDIAN - 查找指定範圍內的中位數。 MEAN - 計算指定範圍的平均值。這是默認設置。 SUM - 計算指定範圍內變量的總和。 MAJORITY - 查找最常出現的值。 MINORITY - 查找出現頻率最低的值。 STD - 計算標準偏差。 PERCENTILE - 計算指定範圍內的定義百分位數。
percentile_value	可選的整數。當 statistics_type 參數設置為 PERCENTILE 時要計算的百分位。該值的範圍是 0 到 100。默認值為 90。
buffer_distance	可選的整數。位置數據要素周圍的指定距離。緩衝距離以位置要素空間參考的線性單位指定。如果要素使用地理參考，則單位將為度。將在此緩衝區內計算統計數據。
layout	可選字符串。指定采樣值是出現在輸出表的行中還是列中。 ROW_WISE - 采樣值出現在輸出表的單獨行中。這是默認設置。 COLUMN_WISE - 采樣值出現在輸出表的單獨列中。此選項僅在輸入多維柵格包含一個變量和一維且每個切片為單波段柵格時才有效。
generate_feature_class	可選 bool，布爾值，用於確定此函數是生成具有采樣值的要素圖層還是僅生成具有采樣值的表。默認情況下，它是 False。
process_as_multidimensional	可選布爾值，如果設置為 True，則處理為多維，如果輸入是多維柵格。
output_name	可選字符串。要創建的輸出特征項或表項的名稱。如果未提供，則該方法會生成一個隨機名稱並用作輸出名稱。
gis	可選的 GIS 對象。如果未指定，則使用當前活動的連接。
future	僅關鍵字參數。可選的布爾值。如果為 True，則結果將是一個 GPJob 對象，並且結果將異步返回。
folder	僅關鍵字參數。可選的 str 或 dict。使用給定的文件夾名稱在門戶中創建一個文件夾(如果不存在)，並將輸出保留在此文件夾中。 create_folder 返回的字典也可以作為輸入傳入。 例子： {‘username’: ‘user1’, ‘id’: ‘6a3b77c187514ef7873ba73338cf1af8’, ‘title’: ‘trial’}

例子：

# Usage Example 1: Create a table that shows values of cells from the raster(s) for defined locations.

raster_1 = gis.content.search("my_raster_1")[0].layers[0]
raster_2 = gis.content.search("my_raster_2")[0].layers[0]
rasters = [raster1, raster2]
location_data = gis.content.search("my_location_data")[0].layers[0]

sample_op = sample(input_rasters=rasters,
                   input_location_data=location_data,
                   output_name="sample_op_data",
                   gis=gis)