工具参考页面剖析

ArcGIS Pro 工具参考中的每个工具页面都遵循同一结构;了解该结构后,您便可以使用任意工具。

摘要和插图

摘要部分包含一段关于工具用途的简短描述。 其中可能包含关于工具工作原理的更加深入的信息。 在某些情况下,摘要后面配有一个插图,用于说明工具用途。

用法

用法部分包含有关工具用法的注释和说明。 如果注释指的是某一参数,则使用该参数的标注(出现在工具对话框上),而不使用该参数的名称(出现在语法中并在 Python 中使用)。 参数的标注与名称之间的关系通常很明确,但在某些情况下会对参数名称进行注释以免混淆。

参数

参数部分可分为两个选项卡:对话框Python

对话框选项卡包含使用地理处理窗格中的工具的参数信息。

Python 选项卡包含在 Python 中使用工具的信息。 该选项卡包含工具语法;参数表具有三列:名称说明数据类型代码示例部分包含演示在 Python 中使用工具的过程的示例。

语法

Python 选项卡上,语法标头下方的第一行包含工具签名。 在 Python 中,使用工具名称而非工具标注。

  • 工具标注显示在工具对话框的顶部。
  • Python 中,工具箱的别名和工具名称紧随 arcpy 之后,中间用下划线隔开。 例如,在 Python 中,交集取反工具标识为 arcpy.analysis.SymDiff
注:

在 ArcPy 中,地理处理工具以两种方法进行组织。 所有工具均以 ArcPy 函数的形式提供,但也可以通过匹配工具箱别名的模块调用。 尽管语法以后一种形式显示工具,但两种方法同样有效。 使用哪一种方法具体取决于个人喜好和编码习惯。

工具可以通过匹配工具箱别名的模块访问。

arcpy.management.GetCount(in_features)

工具可以 arcpy 模块函数的形式访问。

arcpy.GetCount_management(in_features)

也可以通过将工具从地理处理窗格拖动到 Python 窗口中来标识模块名称和工具名称。

参数表

参数表具有三列:标注/名称说明数据类型

参数表根据您使用的是对话框还是 Python 选项卡而有所不同。对话框选项卡显示参数标注,描述涉及地理处理窗格,而 Python 选项卡显示参数名称,描述涉及在 Python 中使用工具。

对于带关键字的布尔参数和字符串参数,两个参数表的差异最为明显。 在参数对话框中,布尔参数显示为复选框,字符串参数显示为标注,而在 Python 中,布尔参数和字符串参数都会将选项显示为字符串关键字。

注:

还可以将鼠标悬停在每个参数旁边的信息按钮 信息 上,以查看与工具对话框中的工具使用方法相关的参数帮助。

工具对话框能够以不同于实际参数顺序的顺序显示参数,因此,只有在极少数情况下,地理处理窗格中的参数顺序才可能与参数表中的顺序不同。 对于 Python,始终使用参数表中显示的顺序。

参数名称与标注

参数标注在工具对话框上使用。 参数名称可用于 Python 中的工具。 参数的标注与名称之间的关系通常很明确,但在某些情况下会对参数名称进行注释以免混淆。

有些工具参数是必选的,有些是可选的。 在工具对话框中,可选参数后标记有(可选)。

参数类型描述

必需项

您必须为必选参数赋值。 这些参数通常是命令中靠前的参数。

可选

这些参数始终位于必需参数之后。 如果没有为可选参数输入值,则将计算并应用默认值。 说明列中描述默认值。

必选参数与可选参数

Python 选项卡可显示接受值列表的参数的其他信息。 列表语法可位于参数名称之后,如下所示:

外观描述

简单列表

简单列表 - 简单列表称为多值参数。

值表

列表的列表 - 数据类型为值表

说明

此列提供有关参数用途及其设置方式(包括关键字选项)的详细信息。

数据类型

每个工具参数都有关联的数据类型。 一些简单的数据类型包括字符串(任意一组字母数字字符)、布尔型(true 或 false 值)和长整型(介于 -2147483648 和 2147483647 之间的整数值)。 除了这些简单的数据类型之外,还有很多专门针对 ArcGIS 中存在的数据(例如坐标系和范围)而构建的一百多个其他数据类型。

注:

数据类型列包含每个参数的受支持 ArcGIS 数据类型。 这与参数支持的 Python 类型不同。 尽管参数将显示多种 ArcGIS 数据类型,但 Python 支持采用字符串形式的大多数参数。

派生输出

派生参数是输出参数,因此不作为工具对话框中的值或 Python 中的参数输入。 在以下情况下,工具将具有派生输出:

  • 工具计算工具(例如获取计数工具,此工具提供了表中记录的计数)返回的值。
  • 工具修改输入数据集(例如计算字段工具,此工具可修改字段值)。
  • 名称或位置根据输入参数或其他已知位置确定的输出数据集(例如要素类至要素类工具),可通过工作空间和要素类名称参数来确定输出路径。

返回值

Spatial AnalystImage Analyst 扩展模块中的许多工具都支持地图代数,并且可以在 Python 中通过代数格式进行访问。 也就是说,在等号左侧标识名称的对象是根据在等号右侧指定的工具或运算符来创建的。 这些工具包括与派生输出部分相似的返回值部分。 尽管返回值部分中的参数未在 Python 中表示为参数,并且以值的形式返回,但其与派生输出参数不同,并且作为工具对话框中的值输入。

了解有关地图代数的详细信息

代码示例

代码示例部分包含一个或多个示例,用于说明如何在 Python 中执行和使用工具。

环境

环境部分提供工具所遵循的环境设置列表。 在列表中单击任意链接转至其参考页面。 如果某一环境设置对工具十分重要,则可能提供有关此设置的更多详细信息。

许可信息

许可信息部分详细说明工具是否可在某一特定许可级别上运行,并注释其是否需要扩展模块。 例如,Basic:是表示此工具使用 ArcGIS Pro Basic 许可运行,而 Basic:需要 3D Analyst 则表示只有同时使用 ArcGIS 3D Analyst extensionArcGIS Pro Basic 许可才能运行此工具。