ArcGIS Pro ツール リファレンスのすべてのツール ページは、常に同じ記述で記載されています。この構造を理解することで、どのツールも容易に使用できるようになります。
ツール リファレンス ページの要素
ツール ページを表示するには、検索するか、ツールボックス、ツールセットの順に展開し、ツールをクリックしてページを読み込んで選択します。次の情報が表示されます。
概要と図
概要は、ツールの機能の簡単な説明です。ツールの仕組みの詳細情報へのリンクが含まれている場合もあります。概要の後に、ツールの動作を説明する図が掲載されている場合もあります。
使用法
「使用法」セクションには、ツールの使用に関する注意や説明が含まれています。特定のパラメーターについての注意事項が記載される場合には、パラメーター名 (構文で示され、Python で使用されるもの) ではなく、パラメーター ラベル (ツールのダイアログ ボックスに表示されるもの) が使用されます。通常、パラメーターのラベルと名前の対応関係は一目で分かりますが、混乱を避けるために名前が記載されることもあります。
構文 (パラメーターのリストを含む)
「構文」セクションでは、Python でツールを実行するのに必要な一連のパラメーターとその形式が説明されています。構文の後には、名前、説明、およびデータ タイプを含むすべてのパラメーターを一覧表示するテーブルが示されます。ツール リファレンス ページのこのセクションの詳細については、後述の「デコードされるツールの構文」をご参照ください。
コードのサンプル
「コードのサンプル」セクションは、ツールの実行方法と Python での使用方法を示す 1 つ以上の例を示しています。
環境
「環境」セクションは、ツール使用時の環境設定のリストです。リスト内のリンクをクリックすると、そのリファレンス ページに移動します。ツールにとって特定の環境設定が重要である場合は、その設定に関するさらに詳しい情報が掲載されている場合があります。
ライセンス情報
「ライセンス情報」セクションでは、ツールが特定のライセンス レベルで動作するかどうかが詳細に説明され、エクステンションが必要かどうかが注記されています。たとえば、[ArcGIS Desktop Basic: はい] と記載されている場合、このツールは ArcGIS Desktop Basic ライセンスで動作します。また、[ArcGIS Desktop Basic: 3D Analyst が必要] と記載されていれば、ツールを実行できるのは、ArcGIS Desktop Basic ライセンスと一緒に 3D Analyst エクステンションを使用している場合のみになります。
デコードされるツールの構文
ツールのリファレンス ページの構文セクションに、各ツールのパラメーターが詳細に説明されています。Python でツールを使用する際の構文も記述されています。
ツール名とエイリアス
構文ヘッダーの下にある最初の行にはツール シグネチャを含みます。Python では、ツール ラベルの代わりにツール名を使用します。
- ツール ラベルは、ツール ダイアログ ボックスの上部に表示されます。
- Python では、ツール名の後にアンダースコア (_) で区切ってツールボックス エイリアスが続きます。たとえば、Python では、[シンメトリカル ディファレンス (Symmetrical Difference)] ツールは SymDiff_analysis として識別されます。
パラメーター テーブル
ツール シグネチャに続くのが、パラメーター、説明、データ タイプ という 3 列からなるパラメーター テーブルです。パラメーター テーブルの行は、常にパラメーター順です (ツール シグネチャと同じ順序)。
メモ:
ジオプロセシング ツール トピックのパラメーターのヘルプは、多くの場合、Python を念頭に置いてパラメーターを説明しています。これは特に、ブール型パラメーターと、キーワードを含む文字列型パラメーターにおいて顕著です。ツール ダイアログ ボックスのツールの使用に関連するパラメーター ヘルプは、各パラメーターの横にある情報ボタン 
の上にカーソルを置くと表示されます。
ツールのダイアログ ボックスでは、実際のパラメーターとは異なる順序でパラメーターを表示できます。そのため、まれではありますが、ツールのダイアログ ボックスに表示されるパラメーターの順序とパラメーター テーブルの順序が異なることがありえます。Python の場合は、常にパラメーター テーブルで示された順序を使用します。
ツール パラメーターには必須とオプションがあります。オプション パラメーターは、ツール ダイアログ ボックス上でパラメーターの後に [(オプション)] と表示されます。
| パラメーターのタイプ | 説明 |
|---|---|
必須 | 必須パラメーターについては、値の入力が必要です。コマンドの最初のパラメーターは常に必須パラメーターです。 |
オプション | これらのパラメーターは常に必須パラメーターの次に配置されています。オプション パラメーターの値を入力しない場合は、デフォルトの値が計算され、使用されます。デフォルト値は、[説明] 列に記載されています。 |
オプション パラメーター名は、Python ではショートカットとして役に立ちます。空の引用符 ("") やシャープ記号 ("#") を指定して、使用しないオプション パラメーターをスキップする代わりに、パラメーター名を使用してパラメーターを明示的に設定できます。
# Use the parameter name to bypass unused optional arguments
arcpy.AddField_management("c:/data/streets.shp", "Address", "TEXT", field_length=120)パラメーターの名前とラベル
パラメーター ラベルは、ツールのダイアログ ボックスで使用されます。パラメーター名は、パラメーター テーブルで使用されます。パラメーターのラベルと名前との関係は、通常は明確に示されますが、混乱を避けるために、パラメーター名が記載されることもあります。
リストを使用できるパラメーター
値のリストを受け入れるパラメーターの場合、次に示すように、リストの構文はパラメーター名の後に記述されます。
| 表示設定 | 説明 |
|---|---|
| シンプル リスト: シンプル リストは複数値パラメーターと呼ばれています。 |
| リストのリスト: データ タイプは Value Table です。 |
シンプル リストは、単一値のリストを含みます。上記の例では、Distances パラメーターのデータ タイプ ([データ タイプ] 列で示されます) は double です。このリストは、次のいずれかの方法で表現できます。
# Method 1: A list of numbers dist = [10.0, 20.0, 30.0]
# Method 2: A list of strings dist = ["10.0", "20.0", "30.0"]
# Method 3: String representation of a list dist = "10.0; 20.0; 30.0"リストのリストのデータ タイプは Value Table です。上記の例では、in_features パラメーターはリストのリストで、個々のリストはフィーチャ データセットまたはレイヤーのパスおよびオプションの整数値ランクを含みます。このパラメーターは、次のいずれかの方法で表記できます。
# Method 1: A list of lists inFeatures = [["counties", 2], ["parcels", 1], ["state"]]
# Method 2: A list of strings inFeatures = ["counties 2", "parcels 1", "state"]
# Method 3: String representation, each list separated by a semicolon inFeatures = "counties 2; parcels 1; state"説明列
この列には、パラメーターの使用目的、キーワード オプションも含めたパラメーターの設定方法について詳細情報が記載されます。
キーワードは文字列です。ツールを呼び出すとき、キーワードは常に引用符で囲みます。たとえば、[フィールドの追加 (Add Field)] ツールには、次のフィールド タイプを示すキーワードがあります。# Add a field named IDField with data type of long
arcpy.AddField_management("Parks", "IDField", "LONG", field_is_nullable="NULLABLE",
field_is_required="NON_REQUIRED")
データ タイプ
どのツール パラメーターもデータ タイプが関連付けられています。シンプルなデータ タイプとしては、string (任意の文字列)、Boolean (true または false)、long (-2,147,483,648 ～ 2,147,483,647 の整数値) などがあります。このようなシンプルなデータ タイプに加えて、座標系や範囲など、ArcGIS のデータ専用のデータ タイプが多数あります。
派生した出力
派生したパラメーターとは、ツールのダイアログ ボックスに値として、あるいは Python の引数として入力されていない出力パラメーターです。ツールは、次のような場合に派生した出力を持ちます。
- テーブルのレコード数を示す [行のカウント (Get Count)] ツールのように、ツールによって返された値を計算する場合。
- フィールド値を変更する [フィールド演算 (Calculate Field)] ツールのように、ツールが入力データセットを変更する場合。
- ワークスペースとフィーチャクラス名パラメーターから出力パスを判断する [フィーチャクラス → フィーチャクラス (Feature Class to Feature Class)] のように、出力データセットの名前や場所が入力パラメーターやその他の既知の場所から特定される場合。
スクリプティング オブジェクトの使用
ツールのパラメーターは通常、単純なテキスト文字列を使用して定義されます。データセット名、パス、キーワード、フィールド名、許容値、およびドメイン名は、引用符付き文字列を使用して指定できます。
パラメーターの中には、多数のプロパティを必要とする複雑なパラメーターがあり、単純な文字列を使用してこれらを定義することは困難です。長く複雑なテキスト文字列を使用してこれらのパラメーターを定義する代わりに、クラスを使用できます (たとえば、SpatialReference、ValueTable、および Point の各クラス)。各ツールの資料には、それぞれのツール パラメーターを定義して使用する方法を示したスクリプト例が記載されています。
次に示す例では、[フィーチャクラスの作成 (Create Feature Class)] ツールを使用して作成されたフィーチャクラスの出力座標系を定義するために、SpatialReference オブジェクトを作成し、使用しています。
import arcpy
inputWorkspace = "c:/temp"
outputName = "rivers.shp"
prjFile = "c:/projections/North America Equidistant Conic.prj"
spatialRef = arcpy.SpatialReference(prjFile)
# Run CreateFeatureclass using the spatial reference object
arcpy.CreateFeatureclass_management(inputWorkspace, outputName, "POLYLINE",
"", "", "", spatialRef)多くのジオプロセシング ワークフローでは、座標とジオメトリの情報を使用して特定の操作を行うことだけが必要で、(一時な) フィーチャクラスを作成し、カーソルを使用してフィーチャクラスにデータを設定し、そのフィーチャクラスを使用し、最後に一時フィーチャクラスを削除するというプロセスをすべて行う必要はないことがあります。ジオプロセシングを簡単に実行できるように、入力および出力の両フィーチャクラスの代わりにジオメトリ オブジェクトを使用できます。Multipoint、PointGeometry、Polygon、または Polyline の各クラスを使用して、ジオメトリ オブジェクトを最初から作成できます。