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")