Python ArcGIS ImageryLayer.query用法及代碼示例

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

用法:

query(where=None, out_fields='*', time_filter=None, geometry_filter=None, return_geometry=True, return_ids_only=False, return_count_only=False, pixel_size=None, order_by_fields=None, return_distinct_values=None, out_statistics=None, group_by_fields_for_statistics=None, out_sr=None, return_all_records=False, object_ids=None, multi_dimensional_def=None, result_offset=None, result_record_count=None, max_allowable_offset=None, true_curves=False, as_df=False, raster_query=None, return_extent_only=False)

返回：

當 return_geometry 為 True 時，包含與查詢匹配的足跡(特征)的 FeatureSet ，否則包含預期返回類型的字典。

query 方法通過應用用戶指定的過濾器來查詢ImageryLayer。此操作的結果是一組要素或柵格 ID 數組(如果 return_ids_only 設置為 True)、計數(如果 return_count_only 設置為 True)或一組字段統計數據(如果 out_statistics 用來)。

Parameter	Description
where	可選字符串。該圖層上的 where 子句通過選擇 sql 語句過濾圖像圖層。對柵格中的字段進行操作的任何合法 SQL where 子句
out_fields	可選字符串。要返回的屬性字段，以逗號分隔的字段名稱列表。
time_filter	可選的 datetime.date、datetime.datetime 或時間戳(以毫秒為單位)。查詢的時刻或時間範圍。 語法：time_filter=<timeInstant> 指定為 [<startTime>, <endTime>] 列表的時間範圍 對於時間範圍，<startTime> 或 <endTime> 之一可以為 None。為開始時間或結束時間指定的“無”值將分別表示開始時間或結束時間為無窮大。語法：time_filter=[<開始時間>, <結束時間>] ;指定為 datetime.date、datetime.datetime 或時間戳(以毫秒為單位)
geometry_filter	可選的 arcgis.geometry.filters。 arcgis.geometry.filters 模塊中的空間過濾器，通過與另一個幾何圖形的空間關係來過濾結果。
return_geometry	可選布爾值。 True 表示將返回幾何圖形，否則僅返回屬性
return_ids_only	可選布爾值。默認為假。 True 表示僅返回 OBJECTID
return_count_only	可選布爾值。如果為True，則僅根據sql語句返回一個整數
return_extent_only	可選布爾值。如果為 True，則僅返回範圍。此參數從 10.8.1 開始可用。
pixel_size	可選的字典或字符串。查詢給定像素大小的可見柵格。如果不指定pixel_size，則可以查詢所有分辨率的柵格。句法： dictionary structure: pixel_size={point} Point simple syntax: pixel_size=’<x>,<y>’ 例子： pixel_size={“x”: 0.18, “y”: 0.18} pixel_size='0.18,0.18'
order_by_fields	可選字符串。按一個或多個字段名稱對結果進行排序。分別使用 ASC 或 DESC 進行升序或降序。
return_distinct_values	可選布爾值。如果為 true，則根據 out_fields 中指定的字段返回不同的值。僅當圖像層的supportsAdvancedQueries 屬性為true 時，此參數才適用。
out_statistics	可選的字典或字符串。要計算的一個或多個基於字段的統計數據的定義。
group_by_fields_for_statistics	可選的字典/字符串。使用需要分組以計算統計數據的一個或多個字段名稱。
out_sr	可選字典，SpatialReference。如果返回的幾何圖形需要位於不同的空間參考中，請為函數提供所需的 WKID。
return_all_records	可選布爾值。如果為 True(默認)，將返回所有記錄。 False 表示僅返回限製的記錄。
object_ids	可選字符串。要查詢的柵格目錄的對象 ID。指定此參數後，任何其他過濾器參數(包括 where)都將被忽略。當指定該參數時，設置return_ids_only=true無效。語法：objectIds=<objectId1>, <objectId2> 示例：objectIds=37, 462
multi_dimensional_def	可選字典。由多個維度定義定義的過濾器。
result_offset	可選整數。此選項通過跳過指定數量的記錄來獲取查詢結果。查詢結果從下一條記錄開始(即resultOffset + 1)。默認值為無。
result_record_count	可選整數。此選項獲取最多指定的 resultRecordCount 的查詢結果。當指定了 resultOffset 而未指定該參數時，圖像層默認為 maxRecordCount。此參數的最大值是圖層的 maxRecordCount 屬性的值。 max_allowable_offset - 此選項可用於指定 max_allowable_offset 用於概括查詢操作返回的幾何圖形。 max_allowable_offset以out_sr為單位。如果未指定outSR，則假定max_allowable_offset以層的空間參考為單位。
true_curves	可選布爾值。如果為 true，則返回輸出幾何圖形中的真實曲線，否則曲線將轉換為致密折線或多邊形。
as_df	可選布爾值。以 DataFrame 對象的形式返回查詢結果
raster_query	可選字符串。根據每個柵格目錄項的關鍵屬性進行查詢。允許對柵格目錄項的關鍵屬性進行任何合法的 SQL where 子句操作。 示例：LANDSAT_WRS_PATH >= 150 AND LANDSAT_WRS_PATH<= 165 此選項是在 10.8.1 中添加的。

例子：

# Usage Example

img_lyr = gis.content.search("my_image_service", item_type="Imagery Layer")[0].layers[0]
search_res = img_lyr.query(where="OBJECTID=1")