概要
フィーチャクラスの属性を、空間リレーションシップに基づいて別のフィーチャクラスの属性に結合します。ターゲット フィーチャと、結合フィーチャの結合された属性は、出力フィーチャクラスに書き込まれます。
使用法
空間結合では、[結合フィーチャ] から [ターゲット フィーチャ] への行のマッチが、相対的な空間位置に基づいて行われます。
デフォルトでは、結合フィーチャのすべての属性がターゲット フィーチャの属性に追加され、出力フィーチャクラスにコピーされます。出力に書き込む属性は、[結合フィーチャのフィールド マップ] パラメーターで操作することで定義できます。
2 つの新しいフィールド、Join_Count および TARGET_FID は、常に出力フィーチャクラスに追加されます。Join_Count は、結合フィーチャが各ターゲット フィーチャ (TARGET_FID) と一致する数を示します。
[結合方法] パラメーターに JOIN_ONE_TO_MANY が指定されている場合、別の新しいフィールド JOIN_FID が出力に追加されます。
[結合方法] パラメーターが JOIN_ONE_TO_MANY である場合、各ターゲット フィーチャの出力フィーチャクラスには複数の行が存在する場合があります。JOIN_FID フィールドにより、どのフィーチャがどのターゲット フィーチャ (TARGET_FID) に結合されるかをより簡単に判断できます。JOIN_FID フィールドの値が -1 であれば、指定されたターゲット フィーチャとの空間リレーションシップを持つフィーチャがないことを意味します。
すべての入力ターゲット フィーチャは、次の両方の条件を満たす場合にのみ出力フィーチャクラスに書き込まれます。
- [結合方法] が JOIN_ONE_TO_ONE に設定されている。
- [すべてのターゲット フィーチャを保持する] をオンにしている (Python の join_type = "KEEP_ALL")。
[結合フィーチャのフィールド マップ] パラメーターに指定したマージ ルールは、複数のフィーチャがターゲット フィーチャにマッチしたときに (Join_Count > 1)、結合フィーチャの属性にだけ適用されます。たとえば、「DEPTH」属性の値に 15.5、2.5、および 3.3 を持つ 3 つのフィーチャが結合され、マージ ルールとして [平均] が適用される場合、出力フィールドの値は 6.1 になります。結合フィーチャの NULL 値は統計計算では無視されます。たとえば、3 つのフィーチャの値が 15.5、<NULL>、および 2.5 である場合、[平均] は 9.0、[数] は 2 になります。
[マッチ オプション] が CLOSEST または CLOSEST_GEODESIC に設定されているときに、2 つ以上の結合フィーチャがターゲット フィーチャから同じ距離に存在する場合があります。この場合は、結合フィーチャのいずれかが、マッチするフィーチャとしてランダムに選択されます (結合フィーチャの FID は、この選択に影響しません)。2 番目、3 番目、または N 番目に近いフィーチャを検索したい場合は、[近接情報テーブルの生成 (Generate Near Table)] ツールを使用します。
1 つの結合フィーチャに複数のターゲット フィーチャとの空間リレーションシップがある場合、それはマッチするターゲット フィーチャの数だけカウントされます。たとえば、あるポイントが 3 つのポリゴン内にある場合、そのポイントはポリゴンにつき 1 回、合計で 3 回カウントされます。
3 次元空間リレーションシップ (INTERSECT_3D および WITHIN_A_DISTANCE_3D) の使用方法の詳細については、「空間検索の 3D リレーションシップ」をご参照ください。
構文
arcpy.analysis.SpatialJoin(target_features, join_features, out_feature_class, {join_operation}, {join_type}, {field_mapping}, {match_option}, {search_radius}, {distance_field_name})| パラメーター | 説明 | データ タイプ |
target_features | ターゲット フィーチャの属性と結合されたフィーチャの属性は、出力フィーチャクラスに転送されます。ただし、フィールド マップ パラメーターに属性のサブセットを定義することができます。 | Feature Layer |
join_features | 結合フィーチャの属性は、ターゲット フィーチャの属性に結合されます。結合された属性の集約に結合操作がどのように影響するかについては、join_operation パラメーターの説明をご参照ください。 | Feature Layer |
out_feature_class | ターゲット フィーチャの属性と結合フィーチャの属性を含む、新しいフィーチャクラス。デフォルトでは、ターゲット フィーチャのすべての属性と結合されたフィーチャの属性が出力に書き込まれます。ただし、転送する属性のセットはフィールド マップ パラメーターで設定できます。 | Feature Class |
join_operation (オプション) | 単一のターゲット フィーチャと同じ空間リレーションシップを持つ複数の結合フィーチャが検出された場合、ターゲット フィーチャと結合フィーチャの間の結合をどのように処理するかを決定します。
| String |
join_type (オプション) | 出力フィーチャクラスにすべてのターゲット フィーチャを保存するか (外部結合)、結合フィーチャとの空間リレーションシップが指定されたターゲット フィーチャのみを保存するか (内部結合) を指定します。
| Boolean |
field_mapping (オプション) | 出力フィーチャクラスでどの属性フィールドを使用するかを制御します。最初のリストには、ターゲット フィーチャおよび結合フィーチャの両方のすべてのフィールドが含まれます。フィールドの追加、削除、名前の変更や、フィールドのプロパティの変更が可能です。ターゲット フィーチャの選択したフィールドはそのまま転送されますが、結合フィーチャの選択したフィールドは、マージ ルールに従って集約することができます。フィールド マッピングの詳細については、「フィールド マッピング コントロールの使用」と「入力フィールドから出力フィールドへのマッピング」をご参照ください。複数のフィールドと統計情報の組み合わせを指定できます。 | Field Mappings |
match_option (オプション) | 行の一致に使用される条件を定義します。次のような一致オプションがあります。
| String |
search_radius (オプション) | ターゲット フィーチャのこの範囲内にある結合フィーチャが、空間結合の対象と見なされます。検索範囲は、空間リレーションシップ ([マッチ オプション]) の INTERSECT、WITHIN_A_DISTANCE、WITHIN_A_DISTANCE_GEODESIC、HAVE_THEIR_CENTER_IN、CLOSEST または CLOSEST_GEODESIC が指定された場合のみ有効になります。空間リレーションシップ WITHIN_A_DISTANCE で 100 メートルの検索範囲を使用すると、ターゲット フィーチャから 100 メートル以内のフィーチャが結合されます。3 つの WITHIN_A_DISTANCE リレーションシップでは、検索範囲に値が指定されていない場合、0 の距離が使用されます。 | Linear unit |
distance_field_name (オプション) | 出力フィーチャクラスに追加するフィールドの名前。ターゲット フィーチャと最も近い結合フィーチャとの間の距離が含まれます。このオプションは、空間リレーションシップ ([マッチ オプション]) の CLOSEST または CLOSEST_GEODESIC が指定された場合のみ有効になります。検索範囲内にマッチするフィーチャがない場合は、この値を -1 に指定します。フィールド名を指定しないと、このフィールドは出力フィーチャクラスに追加されません。 | String |
コードのサンプル
SpatialJoin (空間結合) の例 1 (Python ウィンドウ)
次のスクリプトは、Python ウィンドウで SpatialJoin (空間結合) 関数を使用する方法を示しています。
import arcpy
target_features = "C:/data/usa.gdb/states"
join_features = "C:/data/usa.gdb/cities"
out_feature_class = "C:/data/usa.gdb/states_cities"
arcpy.SpatialJoin_analysis(target_features, join_features, out_feature_class)
SpatialJoin (空間結合) の例 2 (スタンドアロン スクリプト)
次のスタンドアロン スクリプトは、都市の属性を州に結合するために SpatialJoin (空間結合) 関数を使用する方法を示しています。
# Name: SpatialJoin_Example2.py
# Description: Join attributes of cities to states based on spatial relationships.
# Requirements: os module
# Import system modules
import arcpy
import os
# Set local variables
workspace = r"C:\gpqa\mytools\spatialjoin\usa.gdb"
outWorkspace = r"C:\gpqa\mytools\spatialjoin\output.gdb"
# Want to join USA cities to states and calculate the mean city population
# for each state
targetFeatures = os.path.join(workspace, "states")
joinFeatures = os.path.join(workspace, "cities")
# Output will be the target features, states, with a mean city population field (mcp)
outfc = os.path.join(outWorkspace, "states_mcp2")
# Create a new fieldmappings and add the two input feature classes.
fieldmappings = arcpy.FieldMappings()
fieldmappings.addTable(targetFeatures)
fieldmappings.addTable(joinFeatures)
# First get the POP1990 fieldmap. POP1990 is a field in the cities feature class.
# The output will have the states with the attributes of the cities. Setting the
# field's merge rule to mean will aggregate the values for all of the cities for
# each state into an average value. The field is also renamed to be more appropriate
# for the output.
pop1990FieldIndex = fieldmappings.findFieldMapIndex("POP1990")
fieldmap = fieldmappings.getFieldMap(pop1990FieldIndex)
# Get the output field's properties as a field object
field = fieldmap.outputField
# Rename the field and pass the updated field object back into the field map
field.name = "mean_city_pop"
field.aliasName = "mean_city_pop"
fieldmap.outputField = field
# Set the merge rule to mean and then replace the old fieldmap in the mappings object
# with the updated one
fieldmap.mergeRule = "mean"
fieldmappings.replaceFieldMap(pop1990FieldIndex, fieldmap)
# Delete fields that are no longer applicable, such as city CITY_NAME and CITY_FIPS
# as only the first value will be used by default
x = fieldmappings.findFieldMapIndex("CITY_NAME")
fieldmappings.removeFieldMap(x)
y = fieldmappings.findFieldMapIndex("CITY_FIPS")
fieldmappings.removeFieldMap(y)
#Run the Spatial Join tool, using the defaults for the join operation and join type
arcpy.SpatialJoin_analysis(targetFeatures, joinFeatures, outfc, "#", "#", fieldmappings)
環境
ライセンス情報
- Basic: はい
- Standard: はい
- Advanced: はい