ロケーションの追加 (Add Locations) (Network Analyst)—ArcMap

概要
使用法
構文
コードのサンプル
環境
ライセンス情報

概要

ネットワーク解析レイヤーに入力フィーチャやレコードを追加します。これらの入力は、ストップやバリアなどの特定のサブレイヤーに追加されます。

使用法

このツールを実行して、ネットワーク解析オブジェクトを同じサブレイヤーに繰り返し追加できます。たとえば、ルートレイヤーのストップを 2 つのフィーチャクラスから取得する場合、APPEND オプションを使用してツールを 2 回実行します。
新しいオブジェクトを読み込む前に既存のネットワーク解析オブジェクトを削除するには、CLEAR オプションを使用します。
ネットワークデータセットのネットワークソースとして使用されるフィーチャクラスが有効かつ最新の空間インデックスを保持している場合、このツールは非常に高速に実行されます。

構文

arcpy.na.AddLocations(in_network_analysis_layer, sub_layer, in_table, field_mappings, search_tolerance, {sort_field}, {search_criteria}, {match_type}, {append}, {snap_to_position_along_network}, {snap_offset}, {exclude_restricted_elements}, {search_query})

パラメーター	説明	データタイプ
in_network_analysis_layer	ネットワーク解析オブジェクトが追加されるネットワーク解析レイヤー。	Network Analyst Layer
sub_layer	ネットワーク解析オブジェクトが追加されるネットワーク解析レイヤーのサブレイヤー。	String
in_table	新しいネットワーク解析オブジェクトのソースとなるフィーチャクラスまたはテーブル。	Table View
field_mappings	ネットワーク解析オブジェクトのプロパティに値を設定します。プロパティは定数を設定するか、入力フィーチャクラスまたはテーブルのフィールドに割り当てることができます。 NAClassFieldMappings クラスから取得する NAClassFieldMappings オブジェクトは、パラメーター値を指定するのに使用されます。NAClassFieldMappings オブジェクトは NAClassFieldMap オブジェクトのコレクションで、これを使用すると、ネットワーク解析オブジェクトのプロパティに対して、デフォルト値を指定したり、入力フィーチャからフィールド名をマップしたりできます。読み込むデータに、解析に使用するネットワークデータセットに基づくネットワークロケーションまたはネットワークロケーション範囲属性がある場合、入力フィーチャのネットワークロケーションフィールドをネットワークロケーションプロパティに割り当てます。フィールドマッピングのネットワークロケーションフィールドを指定することは、ツールダイアログボックスの [ジオメトリの代わりにネットワークロケーションフィールドを使用する] パラメーターを使用するのと同様です。注意: すべてのネットワークロケーションプロパティにフィールドマッピングを指定する場合、残りのネットワークロケーションプロパティのフィールドマッピングを指定して、ツール実行エラーを防ぐ必要があります。	Network Analyst Class FieldMap
search_tolerance	入力フィーチャをネットワークに配置する際の検索許容値。検索許容値の外側にあるフィーチャは配置されません。パラメーターには許容値の値と単位が含まれます。ラインバリアまたはポリゴンバリアのサブレイヤーにロケーションを追加する際には、パラメーターは使用されません。この場合、「"#"」をパラメーター値として使用します。	Linear Unit
sort_field (オプション)	ネットワーク解析オブジェクトをネットワーク解析レイヤーに追加する際に、ネットワーク解析オブジェクトをソートする基準となるフィールド。デフォルトは入力フィーチャクラスまたはテーブルの ObjectID フィールドです。	Field
search_criteria [[Source, SnapType],...] (オプション)	ロケーション検索時に検索するネットワークデータセットのソースと、使用するジオメトリの部分 (スナップタイプとも呼ばれます) を指定します。パラメーター値は、ネストされたリストとともにリストとして指定されます。ネストしたリストは各ネットワークソースの名前とスナップタイプを示す 2 つの値で構成されます。スナップタイプは SHAPE、MIDDLE、END、NONE キーワードを使用して指定されます。 SHAPE- 該当するネットワークソース内にあるエレメントの最近接点にポイントが配置されます。 MIDDLE- 該当するネットワークソース内にあるエレメントの最近接の中間点にポイントが配置されます。 END- 該当するネットワークソース内にあるエレメントの最近接の端点にポイントが配置されます。 NONE- 該当するネットワークソース内にあるエレメントにポイントが配置されません。たとえば、ロケーション検索時には、パラメーター値 [["Streets","SHAPE"],["Streets_ND_Junctions","NONE"]] は、Streets_ND_Junctions ソースでなく Streets ソースの形状に基づいた検索が可能であることを示します。 1 つのネットワークソースに複数のスナップタイプを指定するには、アンダースコアで区切ったスナップタイプキーワードの組み合わせを使用します。たとえば、MIDDLE_END はロケーションがネットワークソースの中間または端点にスナップされることを示します。ラインまたはポリゴンネットワークロケーションを追加する際、他のスナップタイプが指定されていても SHAPE スナップタイプのみが使用されます。このリストに入っていないネットワークソースでは、デフォルトスナップタイプが使用されます。すべてのネットワークソースをリストに入れ、ネットワークソースごとにスナップタイプを明示的に設定することが最も安全な方法です。システムジャンクションのデフォルト値は SHAPE で、システムジャンクションを除くすべてのネットワークソースのデフォルト値は NONE です。	Value Table
match_type (オプション)	ネットワークロケーションの一致方法を指定します。 MATCH_TO_CLOSEST —検索条件に指定されたスナップタイプを保持するすべてのソースの中から最寄りのネットワークソースを新しいネットワークロケーションと照合します。これがデフォルトです。 PRIORITY —検索条件に指定されたスナップタイプを保持する最初のネットワークソースを新しいネットワークロケーションと照合します。ロケーションが検索許容値内で検出される場合、ソースは優先度順に検索しているストップの中から検索されます。ラインバリアまたはポリゴンバリアのサブレイヤーにロケーションを追加する際には、パラメーターは使用されません。この場合、「"#"」をパラメーター値として使用します。	Boolean
append (オプション)	新しいネットワーク解析オブジェクトを既存のオブジェクトに追加するかどうかを指定します。 APPEND —選択されたサブレイヤー内に存在する一連のオブジェクトに新しいネットワーク解析オブジェクトが付加されます。これがデフォルトです。 CLEAR —既存のネットワーク解析オブジェクトが削除され、新規のオブジェクトに置き換えられます。	Boolean
snap_to_position_along_network (オプション)	ネットワークデータセットに沿ってネットワークロケーションをスナップするか、ネットワークデータセットから指定したオフセットにネットワークロケーションをスナップするかどうかを指定します。 NO_SNAP — ネットワークロケーションのジオメトリは入力フィーチャのジオメトリに基づきます。これはネットワークロケーションがエッジのどちら側にあるかを識別している必要があるカーブアプローチを使用する場合に役立ちます。これがデフォルトです。 SNAP —ポイントフィーチャがある場合、ポイントはネットワークにスナップされ、カーブアプローチを使用することはできません。これは車両がどのようにストップに近づくかを知る必要がある場合に役立ちます。入力フィーチャがラインまたはポリゴンの場合、このパラメーター値を使用します。ラインバリアまたはポリゴンバリアのサブレイヤーにロケーションを追加する際には、パラメーターは使用されません。この場合、「"#"」をパラメーター値として使用します。	Boolean
snap_offset (オプション)	ポイントをネットワークにスナップする際、オフセット距離を適用できます。オフセット距離が 0 だと、ポイントはネットワークフィーチャ (一般的にライン) と一致します。ネットワークフィーチャからポイントをオフセットする場合、オフセット距離を入力します。オフセットは、元のポイントの場所に関連しています。つまり、元のポイントが左側にあった場合、新しい場所は左にオフセットされます。元のポイントが右側にあれば、新しいロケーションも右側にオフセットされます。ラインバリアまたはポリゴンバリアのサブレイヤーにロケーションを追加する際には、パラメーターは使用されません。この場合、「"#"」をパラメーター値として使用します。デフォルトは 5 メートルです。ただし、このパラメーターは、snap_to_position_along_network を NO_SNAP に設定すると無視されます。	Linear Unit
exclude_restricted_elements (オプション)	規制されているネットワークエレメントを除外するかどうかを指定します。 EXCLUDE —ネットワークロケーションがネットワークの通過可能な部分にのみ配置されます。これにより、規制またはバリアが原因で到達できないエレメントにネットワークロケーションが配置されなくなります。このオプションを使用してネットワークロケーションを追加する前に、期待している結果を得るためにすべての規制バリアを入力ネットワーク解析レイヤーに追加していることを確認してください。このパラメーターはバリアオブジェクトの追加時には適用できません。この場合、「"#"」をパラメーター値として使用します。これがデフォルトです。 INCLUDE —ネットワークロケーションがネットワークのすべてのエレメントに配置されます。このパラメーターで追加されるネットワークロケーションは、規制が適用されたエレメント上に位置している場合、解析プロセスにおいて到達不能になる可能性があります。	Boolean
search_query [[Source, Expression],...] (オプション)	検索をソースフィーチャクラス内のフィーチャのサブセットに制限するクエリ。この機能は、ネットワークロケーションとして適切でないフィーチャを除外する場合に有用です。たとえば、ポリゴンの重心を読み込む場合に、生活道路に配置したくない場合は、一般道路のみを検索するクエリを定義できます。パラメーター値は、ネストされたリストとともにリストとして指定されます。ネストしたリストはすべてのネットワークソースの名前と SQL 式を示す 2 つの値で構成されます。SQL 式の構文はネットワークソースフィーチャクラスのタイプによって少し異なります。たとえば、クエリ対象がファイルジオデータベース、エンタープライズジオデータベース、シェープファイル、または SDC に格納されたソースフィーチャクラスの場合は、次のようにフィールド名を二重引用符で囲みます: "CFCC"。クエリ対象がパーソナルジオデータベースの場合は、次のようにフィールドを角括弧で囲みます: [CFCC]。特定のソースに対してクエリを定義したくない場合、SQL 式に値として「"#"」を入力するか、またはパラメーター値からソース名と SQL 式を除外します。すべてのネットワークソースに対してクエリを定義したくない場合、パラメーター値として「"#"」を入力します。たとえば、パラメーター値「[["Streets","\"CFCC\" = 'A15'"], ["Streets_ND_Junctions",""]]」では、Streets ソースフィーチャクラスに対する SQL 式を定義し、Streets_ND_Junctions ソースフィーチャクラスには SQL 式を定義しません。フィールド名 CFCC を囲むために使用される二重引用符は、Python インタープリターで構文解析エラーが発生しないようバックスラッシュ文字でエスケープされます。デフォルトでは、クエリは使用されません。	Value Table

派生した出力

名前	説明	データタイプ
output_layer	更新されたネットワーク解析レイヤー。	Network Analyst レイヤー

コードのサンプル

AddLocations (ロケーションの追加) の例 1 (Python ウィンドウ)

必須パラメーターのみを使用してツールを実行します。

hospitals = "C:/Data/SanFrancisco.gdb/Analysis/Hospitals"
arcpy.na.AddLocations("Route", "Stops", hospitals, "", "")

AddLocations (ロケーションの追加) の例 2 (Python ウィンドウ)

すべてのパラメーターを使用してツールを実行します。

hospitals = "C:/Data/SanFrancisco.gdb/Analysis/Hospitals"
arcpy.na.AddLocations("Route", "Stops", hospitals,
                      "Name Name #;Attr_Minutes VisitTime 0;CurbApproach # 0",
                      "2 Miles", "FID",
                      [["Streets", "SHAPE"], ["Streets_ND_Junctions", "NONE"]],
                      "MATCH_TO_CLOSEST", "CLEAR", "SNAP", "10 Feet", "EXCLUDE",
                      [["Streets", '"FREEWAY" = 0'],
                      ["Streets_ND_Junctions", ""]])

AddLocations (ロケーションの追加) の例 3 (ワークフロー)

次のスタンドアロン Python スクリプトは、AddLocations (ロケーションの追加) ツールを使用して起点と終点を OD コストマトリックスレイヤーに読み込む方法を示しています。

# Name: AddLocations_Workflow.py
# Description: The scenario shows how to calculate a travel time matrix between 
#              store features. Use the Add Locations tool to load origins and 
#              destinations into an OD Cost Matrix layer. Since the origins and 
#              destinations are the same in this case, the origins are first loaded 
#              from the store features using their geometry and the destinations
#              are loaded from the origins using network location fields to 
#              speed up the load times. 
# Requirements: Network Analyst Extension 

#Import system modules
import arcpy
from arcpy import env

try:
    #Check out the Network Analyst extension license
    arcpy.CheckOutExtension("Network")

    #Set environment settings
    env.workspace = "C:/data/SanFrancisco.gdb"
    env.overwriteOutput = True
    
    #Set local variables
    inNetworkDataset = "Transportation/Streets_ND"
    outNALayerName = "StoreTravelTimeMatrix"
    impedanceAttribute = "TravelTime"
    inFeatures = "Analysis/Stores"
    searchTolerance = "500 Meters"
    searchQuery = [["Streets",'"FREEWAY" = 0'],["Streets_ND_Junctions",""]]
    odOrigins = "Origins"
    outLayerFile = "C:/data/output" + "/" + outNALayerName + ".lyr"
    
    #Create a new OD cost matrix analysis layer. For this scenario, the default 
    #value for all the remaining parameters statisfies the analysis requirements
    outNALayer = arcpy.na.MakeODCostMatrixLayer(inNetworkDataset, outNALayerName,
                                   impedanceAttribute)
    
    #Get the layer object from the result object. The OD cost matrix layer can 
    #now be referenced using the layer object.
    outNALayer = outNALayer.getOutput(0)
    
    #Get the names of all the sublayers within the OD cost matrix layer.
    subLayerNames = arcpy.na.GetNAClassNames(outNALayer)
    #Stores the layer names that we will use later
    originsLayerName = subLayerNames[odOrigins]
    destinationsLayerName = subLayerNames["Destinations"]
    
    #Get the origin layer object from within the OD cost matrix layer
    #The first layer returned by ListLayers is the OD cost matrix layer itself
    #which we don't want to use.
    for layer in arcpy.mapping.ListLayers(outNALayer)[1:]:
        if layer.datasetName == odOrigins:
            originsLayer = layer
            break
    else:
        raise Exception("Failed to get the origins layer object.")
    
    #Load store features as origins using the geometry of store features.
    #Ensure that the stores are not located on freeways by using a search query.
    #The OD cost matrix layer created previously is referred using its name. 
    arcpy.na.AddLocations(outNALayer,originsLayerName,inFeatures,"",
                          searchTolerance, exclude_restricted_elements = "EXCLUDE",
                          search_query = searchQuery)
    
    #Load origins as destinations using the network locations fields from 
    #origins. This is much faster than loading destinations from the store 
    #features using their geometry as their network locations have already been
    #calculated while loading them origins.
    #Create a field mappings object that supports network location fields from 
    #origins layer using the candidate fields from origins
    originsLayer = arcpy.management.MakeFeatureLayer(originsLayer,
                                                     outNALayerName+originsLayerName)
    candidateFields = arcpy.ListFields(originsLayer.getOutput(0))
    fieldMappings = arcpy.na.NAClassFieldMappings(outNALayer,
                                                  destinationsLayerName, True,
                                                  candidateFields)
    arcpy.na.AddLocations(outNALayer,destinationsLayerName,originsLayer,
                          fieldMappings,"")
    
    #Solve the od cost matrix layer. Halt the execution if there is an 
    #invalid location 
    arcpy.na.Solve(outNALayer,"HALT")
    
    #Save the solved na layer as a layer file on disk with relative paths
    arcpy.management.SaveToLayerFile(outNALayer,outLayerFile,"RELATIVE")
    
    print "Script completed successfully"
    
except Exception as e:
    # If an error occurred, print line number and error message
    import traceback, sys
    tb = sys.exc_info()[2]
    print "An error occurred on line %i" % tb.tb_lineno
    print str(e)

環境

現在のワークスペース

ライセンス情報

Basic: はい
Standard: はい
Advanced: はい