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)