解析レイヤーにフィールドを追加 (Add Field to Analysis Layer) (Network Analyst)

概要

ネットワーク解析レイヤーのサブレイヤーにフィールドを追加します。

使用法

  • このツールは [ロケーションの追加 (Add Locations)] ツールとともによく使用され、入力フィーチャからサブレイヤーへフィールドを転送します。たとえば、UniqueID と呼ばれるフィールドを入力フィーチャから到達圏レイヤーの施設サブレイヤーに転送したい場合、このツールを使用して最初に UniqueID フィールドを施設サブレイヤーに追加して、次に [ロケーションの追加 (Add Locations)] ツールのフィールド割り当てを使用して、UniqueID フィールドへの入力値を設定します。

  • フィールドはネットワーク解析レイヤーのすべてのサブレイヤーに追加することができます。

構文

arcpy.na.AddFieldToAnalysisLayer(in_network_analysis_layer, sub_layer, field_name, field_type, {field_precision}, {field_scale}, {field_length}, {field_alias}, {field_is_nullable})
パラメーター説明データ タイプ
in_network_analysis_layer

新しいフィールドを追加するネットワーク解析レイヤー。

Network Analyst Layer
sub_layer

新しいフィールドを追加するネットワーク解析レイヤーのサブレイヤー。

String
field_name

ネットワーク解析レイヤーの指定されたサブレイヤーに追加されるフィールド名。

String
field_type

新しいフィールドの作成に使用されるフィールドのタイプ。

  • LONG -2,147,483,648〜2,147,483,647の範囲の整数。
  • TEXT任意の文字列。
  • FLOAT -3.4E38〜1.2E38の範囲の有理数。
  • DOUBLE -2.2E308〜1.8E308の範囲の有理数。
  • SHORT -32,768〜32,767の範囲の整数。
  • DATE日付と時刻
  • BLOB大容量バイナリ オブジェクト。BLOB フィールドにアイテムを読み込む、または BLOB フィールドの内容を参照するには、カスタム ローダー、カスタム ビューアー、またはサードパーティ アプリケーションが必要です。
String
field_precision
(オプション)

フィールドに格納できる桁数。小数点以下であるかどうかにかかわらず、すべての桁が対象になります。

パラメーター値は数値フィールド タイプのみに有効です。

Long
field_scale
(オプション)

フィールドに格納できる小数点以下の桁数。このパラメーターは、float タイプと double タイプのデータ フィールドのみで使用します。

Long
field_length
(オプション)

追加するフィールドの長さ。この値は、フィールドの各レコードに許容される文字の最大数を設定します。このパラメーターは、タイプがテキストのフィールドに対してのみ適用されます。

Long
field_alias
(オプション)

フィールド名に割り当てる別名。曖昧なフィールド名を説明するために使用される名前です。このパラメーターの適用対象となるのは、ジオデータベースだけです。

String
field_is_nullable
(オプション)

このフィールドに NULL 値を含めることができるかどうかを指定します。NULL 値は、ゼロや空のフィールドとは異なり、ジオデータベースのフィールドのみでサポートされます。

  • NON_NULLABLEフィールドで NULL 値を使用できません。
  • NULLABLEフィールドで NULL 値を使用できます。これがデフォルトです。
Boolean

派生した出力

名前説明データ タイプ
output_layer

更新されたネットワーク解析レイヤー。

Network Analyst レイヤー

コードのサンプル

AddFieldToAnalysisLayer (解析レイヤーにフィールドを追加) の例 1 (Python ウィンドウ)

次の Python ウィンドウ スクリプトは、UniqueID フィールドを到達圏ネットワーク解析レイヤーの 施設サブレイヤーに追加する方法を示しています。

arcpy.na.AddFieldToAnalysisLayer("Service Area", "Facilities", "UniqueID",
                                    "LONG")
AddFieldToAnalysisLayer (解析レイヤーにフィールドを追加) の例 2 (ワークフロー)

次のスタンドアロン Python スクリプトは、AddFieldToAnalysisLayer (解析レイヤーにフィールドを追加) 機能を使用して、入力の消防署フィーチャの StationID フィールドを到達圏解析から計算される 2 分、3 分、5 分以内の到達圏ポリゴン フィーチャに転送する方法を示しています。StationID フィールドは、消防署フィーチャの他の属性を到達圏ポリゴン フィーチャと結合するために使用することができます。

レガシー:

GetNASublayer 関数を使用して、ネットワーク解析レイヤーのサブレイヤーを取得できます。これは ArcGIS Pro 2.7 で導入されました。以前のソフトウェア バージョンでは、サブレイヤー名をワイルドカードとして使用するネットワーク解析の Layer オブジェクトの listLayers メソッドを使用することがネットワーク解析レイヤーのサブレイヤー オブジェクトを取得する最適な方法でした。

# Name: AddFieldToAnalysisLayer_Workflow.py
# Description: Transfers the Address field from the input fire station
#              features to the 2-,3-, and 5-minute service area polygon features
#              calculated from a service area analysis. The Address field can
#              be used to join other attributes from the fire station features
#              to the service area polygon features.
# Requirements: Network Analyst Extension

#Import system modules
import arcpy
from arcpy import env
import os

try:
    #Check out Network Analyst license if available. Fail if the Network Analyst license is not available.
    if arcpy.CheckExtension("network") == "Available":
        arcpy.CheckOutExtension("network")
    else:
        raise arcpy.ExecuteError("Network Analyst Extension license is not available.")
    
    #Set environment settings
    output_dir = "C:/Data"
    #The NA layer's data will be saved to the workspace specified here
    env.workspace = os.path.join(output_dir, "Output.gdb")
    env.overwriteOutput = True

    #Set local variables
    input_gdb = "C:/Data/SanFrancisco.gdb"
    network = os.path.join(input_gdb, "Transportation", "Streets_ND")
    layer_name = "FireStationsCoverage"
    travel_mode = "Driving Time"
    cutoffs = [2, 3, 5] #minutes
    field_to_add = "Address"
    field_type = "TEXT"
    facilities = os.path.join(input_gdb, "Analysis", "FireStations")
    search_tolerance = "2 Miles"
    out_featureclass = os.path.join(output_dir, "Output.gdb",
                                                    "FireStationsCoverageArea")

    #Create a new service area analysis layer. For this scenario, the default
    #value for all the remaining parameters statisfies the analysis requirements
    result_object = arcpy.na.MakeServiceAreaAnalysisLayer(network, layer_name,
                                                travel_mode, cutoffs=cutoffs)

    #Get the layer object from the result object. The service area layer can now
    #be referenced using the layer object.
    layer_object = result_object.getOutput(0)

    #Get the names of all the sublayers within the service area layer.
    sublayer_names = arcpy.na.GetNAClassNames(layer_object)
    #Stores the layer names that we will use later
    facilities_layer_name = sublayer_names["Facilities"]
    polygons_layer_name = sublayer_names["SAPolygons"]

    #Add the Address field to the Facilities sublayer of the service area layer.
    #This is done before loading the fire stations as facilities so that the
    #Address values can be transferred from the input features to the
    #Facilities sublayer.
    arcpy.na.AddFieldToAnalysisLayer(layer_object, facilities_layer_name,
                                        field_to_add, field_type)

    #Add the fire station features as Facilities and map the Name and the
    #Address fields from the fire station features to the Name and Address
    #properties on the Facilities sublayer
    field_mappings = arcpy.na.NAClassFieldMappings(layer_object,
                                                    facilities_layer_name)
    field_mappings['Name'].mappedFieldName = "Name"
    field_mappings['Address'].mappedFieldName = "Address"
    arcpy.na.AddLocations(layer_object, facilities_layer_name, facilities,
                          field_mappings, search_tolerance)

    #Solve the service area layer
    arcpy.na.Solve(layer_object)

    #Get the layer objects for all the sublayers within the service area layer
    facilities_sublayer = layer_object.listLayers(facilities_layer_name)[0]
    polygons_sublayer = layer_object.listLayers(polygons_layer_name)[0]

    #Transfer the Address field from the Facilities sublayer to the Polygons
    #sublayer of the service area layer since we wish to export the polygons.
    #The FacilityID field in the Polygons sublayer is related to the ObjectID
    #field in the Facilities sublayer.
    arcpy.management.JoinField(polygons_sublayer, "FacilityID",
                                facilities_sublayer, "ObjectID", field_to_add)

    #Export the Polygons sublayer to a feature class on disk.
    arcpy.management.CopyFeatures(polygons_sublayer, out_featureclass)

    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: はい

関連トピック