フィールド演算 (Calculate Field) (データ管理)

サマリー

フィーチャクラス、フィーチャ レイヤー、またはラスターのフィールドの値を計算します。

使用法

    注意:

    このツールを実行すると、入力データが変更されます。 詳細と不要なデータの変更を回避するための方法については、「入力データを変更または更新するツール」をご参照ください。

  • Python 式の詳細については、「フィールド演算 (Calculate Field) の Python の例」をご参照ください。

    Arcade 式の詳細については、「ArcGIS Arcade ガイド」をご参照ください。

    SQL 式の詳細については、「フィールドの計算」をご参照ください。

  • [フィーチャ レイヤーの作成 (Make Feature Layer)][属性検索 (Select Layer By Attribute)] ツールでクエリから作成されたフィーチャなど、一連の選択されているフィーチャに対してこのツールを使用すると、選択されているレコードのみが更新されます。

  • 1 回の操作につき、1 つのフィールドにのみ演算を適用できます。 複数の計算を適用するには、[フィールド演算 (複数) (Calculate Fields)] ツールを使用します。

  • 既存のフィールドの値は上書きされます。 元の値を維持するには、入力テーブルのコピーを作成します。

  • Python の演算の場合、フィールド名は感嘆符で囲まれている必要があります (たとえば、!fieldname!)。

    Arcade の演算の場合、フィールド名に接頭辞 $feature. が付与されている必要があります (たとえば、$feature.fieldname)。

  • テキスト フィールドまたは文字フィールドの文字列の演算を行う場合、ダイアログ ボックスでは、文字列を二重引用符で囲む必要があり (たとえば「"string"」)、スクリプトでは、二重引用符で囲まれた文字列をさらに一重引用符で囲む必要があります (たとえば、'"string"')。

  • 数値を指定するフィールドの演算を行うには、[式] パラメーターに数値を入力します。値を引用符で囲む必要はありません。

  • レガシー:

    arcgis.rand() は、ArcGIS Pro 2.0 以降サポートされなくなりました。代わりに、Python の random モジュールを使用する、同等の関数を使用する必要があります。random モジュールを正常に使用するには、[コード ブロック] パラメーターにインポートとして追加します。

  • [コード ブロック] パラメーターを使用すると、複雑な式を作成できます。 コード ブロックは、ダイアログ ボックスに直接入力するか、スクリプトで文字列として入力します。 式とコード ブロックは接続されています。 コード ブロックの結果が式に渡される必要があるため、コード ブロックが式に関連付けられている必要もあります。

    [コード ブロック] パラメーターは Python 式でのみサポートされています。

  • [コード ブロック] パラメーターで、Pythonmath モジュールおよび形式を使用できます。 追加のモジュールをインポートすることもできます。 math モジュールは、数論的関数と表現関数、べき関数と対数関数、三角関数、角度変換関数、双曲線関数、および数学定数を提供します。 math モジュールの詳細については、「Python」のヘルプをご参照ください。

  • typeextentcentroidfirstPointlastPointarealengthisMultipartpartCount などの Geometry オブジェクトのプロパティを使用して、Python 式 (たとえば、!shape.area!) を作成することができます。

  • Python 式では、ジオメトリの area プロパティや length プロパティに面積や長さの単位を指定して、値を異なる計測単位 (!shape.length@kilometers! など) に変換できます。 データが地理座標系に格納されており、距離単位 (たとえば、マイル) が指定されている場合、長さは測地線アルゴリズムを使用して計算されます。 地理データで面積単位を使用すると、グローブ全体で度 (10 進) が一定でないため、正確な結果になりません。

    ジオプロセシング ツールと距離および面積単位の詳細

  • geodesicArea または geodesicLength プロパティを面積や長さの計測単位と組み合わせて Python 式で使用すると、測地線に基づくフィーチャの面積や長さを計算できます (例: !shape.geodesicArea@hectares! または !shape.geodesicLength@miles!)。

  • ArcGIS アプリケーションは、.cal ファイルの読み書きに UTF-16-LE エンコードを使用します。 ファイルが UTF-16-LE エンコードを使用して書き込まれている限り、その他のアプリケーション (メモ帳など) を使用して、.cal ファイルを作成または変更できます。 他のエンコードを使用すると、ファイルがコード ブロックに読み込まれなくなります。

  • 結合したデータの演算を行う際、結合された列を直接演算することはできません。 元のテーブルの列の演算を直接行うことはできます。 結合されたデータの演算を行うには、はじめに、結合されたテーブルまたはレイヤーをマップに追加します。 そうすると、このデータの演算を単体で行うことができるようになります。 これらの変更は結合された列に反映されます。

  • NULL を含む文字列フィールドの連結やゼロ値での除算を試みる Python 式は、このフィールド値として NULL を返します。

  • SQL 式は、フィーチャ サービスやエンタープライズ ジオデータベースの高速な計算をサポートします。 一度に 1 つのフィーチャまたは行を計算する代わりに、サーバーまたはデータベースに 1 つのリクエストが送信されるので、計算が高速化します。

    フィーチャ サービスとエンタープライズ ジオデータベースだけが SQL 式をサポートしています。 他の形式では、Python または Arcade 式を使用します。

    [式の種類] パラメーターの [SQL] オプションの使用には、次の制限があります。

    • このオプションは、Db2OraclePostgreSQLSAP HANA、および SQL Server のエンタープライズ ジオデータベースのみでサポートされています。
    • 結合テーブルのフィールド値の計算はサポートされていません。
    • バージョン対応登録されたエンタープライズ ジオデータベース データと履歴管理が有効化されたエンタープライズ ジオデータベース データはサポートされていません。
    • ジオプロセシング ツールを元に戻す機能はサポートされていません。

    SQL 式のヘルプは、データベース ベンダーのドキュメントをご参照ください。

パラメーター

ラベル説明データ タイプ
入力テーブル

新しい演算で更新されるフィールドを含んでいるテーブル。

Mosaic Layer; Raster Layer; Table View
フィールド名 (既存または新規)

新しい演算で更新するフィールド。

指定された名前のフィールドが入力テーブルに存在しない場合は、フィールドが追加されます。

Field

選択されている行を設定する値を作成するために使用される単純な演算式。

SQL Expression
式のタイプ
(オプション)

使用される式のタイプを指定します。

Python 式の詳細については、「フィールド演算 (Calculate Field) の Python の例」をご参照ください。

Arcade 式の詳細については、「ArcGIS Arcade ガイド」をご参照ください。

SQL 式の詳細については、「フィールドの計算」をご参照ください。

SQL 式は、フィーチャ サービスやエンタープライズ ジオデータベースの高速な計算をサポートします。 一度に 1 つのフィーチャまたは行を計算する代わりに、サーバーまたはデータベースに 1 つのリクエストが設定されるので、計算が大幅に高速化します。

フィーチャ サービスとエンタープライズ ジオデータベースだけが SQL 式をサポートしています。 他の形式では、Python または Arcade 式を使用します。

  • Python 3Python 式の種類が使用されます。 これがデフォルトです。
  • ArcadeArcade 式の種類が使用されます。
  • SQLSQL 式の種類が使用されます。
String
コード ブロック
(オプション)

複雑な式に入力するコード ブロック。

String
フィールド タイプ
(オプション)

新しいフィールドのフィールド タイプを指定します。 フィールド名が入力テーブルに存在しない場合にのみ、このパラメーターが使用されます。

フィールドのタイプがテキストの場合、新しいフィールドの長さは 512 です。 シェープファイルおよび dBASE ファイルの場合、フィールドの長さは 254 です。 新しいフィールドの長さは、[フィールドの変更 (Alter Field)] ツールを使用して調整できます。

  • Textフィールド タイプはテキストです。 テキスト フィールドは文字列をサポートします。
  • Float (32 ビット浮動小数点)フィールド タイプは Float です。 Float フィールドは、-3.4E38 ~ 1.2E38 の範囲の有理数をサポートします。
  • Double (64 ビット浮動小数点)フィールド タイプは Double です。 Double フィールドは、-2.2E308 ~ 1.8E308 の範囲の有理数をサポートします。
  • Short (16 ビット整数)フィールド タイプは Short です。 Short フィールドは、-32,768 〜 32,767 の範囲の整数をサポートします。
  • Long (32 ビット整数)フィールド タイプは Long です。 Long フィールドは、-2,147,483,648 ~ 2,147,483,647 の範囲の整数をサポートします。
  • Dateフィールド タイプは日付です。 日付フィールドは、日付値と時間値をサポートします。
  • Blob (バイナリ データ)フィールド タイプは BLOB です。 BLOB フィールドは、大容量バイナリ オブジェクトとして格納されたデータをサポートします。 BLOB フィールドにアイテムを読み込む、または BLOB フィールドの内容を参照するには、カスタム ローダー、カスタム ビューアー、またはサードパーティ アプリケーションが必要です。
  • Raster imageryフィールド タイプはラスターです。 ラスター フィールドでは、ラスター データをジオデータベース内またはジオデータベースとともに格納できます。 ArcGIS ソフトウェアでサポートされているラスター データセット形式はすべて格納できますが、小さい画像のみを使用することをおすすめします。
  • GUID (Globally Unique Identifier)フィールド タイプは GUID です。 GUID フィールドには、中括弧 ({}) で囲まれた 36 文字のレジストリ形式の文字列が格納されます。
String
ドメインを設定
(オプション)

フィールド ドメイン ルールを適用するかどうかを指定します。

  • オン - フィールド ドメイン ルールが適用されます。 フィールドを更新できない場合、フィールド値は変更されず、ツールのメッセージには警告メッセージが表示されます。
  • オフ - フィールド ドメイン ルールは適用されません。 これがデフォルトです。
Boolean

派生した出力

ラベル説明データ タイプ
更新された入力テーブル

更新されたテーブル。

Table View; Raster Layer; Mosaic Layer

arcpy.management.CalculateField(in_table, field, expression, {expression_type}, {code_block}, {field_type}, {enforce_domains})
名前説明データ タイプ
in_table

新しい演算で更新されるフィールドを含んでいるテーブル。

Mosaic Layer; Raster Layer; Table View
field

新しい演算で更新するフィールド。

指定された名前のフィールドが入力テーブルに存在しない場合は、フィールドが追加されます。

Field
expression

選択されている行を設定する値を作成するために使用される単純な演算式。

SQL Expression
expression_type
(オプション)

使用される式のタイプを指定します。

  • PYTHON3Python 式の種類が使用されます。 これがデフォルトです。
  • ARCADEArcade 式の種類が使用されます。
  • SQLSQL 式の種類が使用されます。

Python 式の詳細については、「フィールド演算 (Calculate Field) の Python の例」をご参照ください。

Arcade 式の詳細については、「ArcGIS Arcade ガイド」をご参照ください。

SQL 式の詳細については、「フィールドの計算」をご参照ください。

SQL 式は、フィーチャ サービスやエンタープライズ ジオデータベースの高速な計算をサポートします。 一度に 1 つのフィーチャまたは行を計算する代わりに、サーバーまたはデータベースに 1 つのリクエストが設定されるので、計算が大幅に高速化します。

フィーチャ サービスとエンタープライズ ジオデータベースだけが SQL 式をサポートしています。 他の形式では、Python または Arcade 式を使用します。

String
code_block
(オプション)

複雑な式に入力するコード ブロック。

String
field_type
(オプション)

新しいフィールドのフィールド タイプを指定します。 フィールド名が入力テーブルに存在しない場合にのみ、このパラメーターが使用されます。

フィールドのタイプがテキストの場合、新しいフィールドの長さは 512 です。 シェープファイルおよび dBASE ファイルの場合、フィールドの長さは 254 です。 新しいフィールドの長さは、[フィールドの変更 (Alter Field)] ツールを使用して調整できます。

  • TEXTフィールド タイプはテキストです。 テキスト フィールドは文字列をサポートします。
  • FLOATフィールド タイプは Float です。 Float フィールドは、-3.4E38 ~ 1.2E38 の範囲の有理数をサポートします。
  • DOUBLEフィールド タイプは Double です。 Double フィールドは、-2.2E308 ~ 1.8E308 の範囲の有理数をサポートします。
  • SHORTフィールド タイプは Short です。 Short フィールドは、-32,768 〜 32,767 の範囲の整数をサポートします。
  • LONGフィールド タイプは Long です。 Long フィールドは、-2,147,483,648 ~ 2,147,483,647 の範囲の整数をサポートします。
  • DATEフィールド タイプは日付です。 日付フィールドは、日付値と時間値をサポートします。
  • BLOBフィールド タイプは BLOB です。 BLOB フィールドは、大容量バイナリ オブジェクトとして格納されたデータをサポートします。 BLOB フィールドにアイテムを読み込む、または BLOB フィールドの内容を参照するには、カスタム ローダー、カスタム ビューアー、またはサードパーティ アプリケーションが必要です。
  • RASTERフィールド タイプはラスターです。 ラスター フィールドでは、ラスター データをジオデータベース内またはジオデータベースとともに格納できます。 ArcGIS ソフトウェアでサポートされているラスター データセット形式はすべて格納できますが、小さい画像のみを使用することをおすすめします。
  • GUIDフィールド タイプは GUID です。 GUID フィールドには、中括弧 ({}) で囲まれた 36 文字のレジストリ形式の文字列が格納されます。
String
enforce_domains
(オプション)

フィールド ドメイン ルールを適用するかどうかを指定します。

  • ENFORCE_DOMAINSフィールド ドメイン ルールが適用されます。
  • NO_ENFORCE_DOMAINSフィールド ドメイン ルールは適用されません。 これがデフォルトです。
Boolean

派生した出力

名前説明データ タイプ
out_table

更新されたテーブル。

Table View; Raster Layer; Mosaic Layer

コードのサンプル

CalculateField の例 1 (Python ウィンドウ)

次の Python ウィンドウ スクリプトは、イミディエイト モードで CalculateField 関数を使用する方法を示しています。

import arcpy
arcpy.env.workspace = "C:/data"
arcpy.management.AddField("vegtable.dbf", "VEG_TYP2", "TEXT", "", "", "20")
arcpy.management.CalculateField("vegtable.dbf", "VEG_TYP2", 
                                '!VEG_TYPE!.split(" ")[-1]', "PYTHON3")
CalculateField の例 2 (スタンドアロン スクリプト)

CalculateField 関数を使用して、新しいフィールドに重心の値を割り当てます。

# Name: CalculateField_centroids.py

# Import system modules
import arcpy

# Set environment settings
arcpy.env.workspace = "C:/data/airport.gdb"
 
# Set local variables
inFeatures = "parcels"
fieldName1 = "xCentroid"
fieldName2 = "yCentroid"
fieldPrecision = 18
fieldScale = 11
 
# Add fields
arcpy.management.AddField(inFeatures, fieldName1, "DOUBLE", 
                          fieldPrecision, fieldScale)
arcpy.management.AddField(inFeatures, fieldName2, "DOUBLE", 
                          fieldPrecision, fieldScale)
 
# Calculate centroid
arcpy.management.CalculateField(inFeatures, fieldName1, 
                                "!SHAPE.CENTROID.X!",
                                "PYTHON3")
arcpy.management.CalculateField(inFeatures, fieldName2, 
                                "!SHAPE.CENTROID.Y!",
                                "PYTHON3")
CalculateField の例 3 (スタンドアロン スクリプト)

CalculateField 関数とコード ブロックを使用して、範囲に基づいて値の演算を行います。

# Name: CalculateField_ranges.py

# Import system modules
import arcpy
 
# Set environment settings
arcpy.env.workspace = "C:/data/airport.gdb"
 
# Set local variables
inTable = "parcels"
fieldName = "areaclass"
expression = "getClass(float(!SHAPE.area!))"

codeblock = """
def getClass(area):
    if area <= 1000:
        return 1
    if area > 1000 and area <= 10000:
        return 2
    else:
        return 3"""
 
# Run AddField
arcpy.management.AddField(inTable, fieldName, "SHORT")
 
# Run CalculateField 
arcpy.management.CalculateField(inTable, fieldName, expression, "PYTHON3", 
                                codeblock)
CalculateField の例 4 (スタンドアロン スクリプト)

CalculateField 関数を使用して、新しいフィールドにランダム値を割り当てます。

# Name: CalculateField_Random.py

# Import system modules
import arcpy
import random
 
# Set environment settings
arcpy.env.workspace = "C:/data/airport.gdb"
  
# Set local variables
inFeatures = "parcels"
fieldName = "RndValue"
expression = "random.randint(0, 10)"
code_block = "import random"
 
# Run AddField
arcpy.management.AddField(inFeatures, fieldName, "LONG")
 
# Run CalculateField 
arcpy.management.CalculateField(inFeatures, fieldName, expression, "PYTHON3", 
                                code_block)
CalculateField の例 5 (Python ウィンドウ)

次の Python ウィンドウ スクリプトは、ARCADE のイミディエイト モードで CalculateField 関数を使用する方法を示しています。

import arcpy
arcpy.env.workspace = "C:/data/fgdb.gdb"
arcpy.management.CalculateField("data", "new_value", "$feature.value1 + $feature.value2", "ARCADE")
CalculateField の例 6 (Python ウィンドウ)

次の Python ウィンドウ スクリプトは、SQL のイミディエイト モードで CalculateField 関数を使用する方法を示しています。

import arcpy
feature_service = "<a feature service url>"
arcpy.management.CalculateField("data", "NEW_VALUE", "SAMPLE * (BASELINE - 40)", "SQL")

環境

特殊なケース

フィールド ドメインの説明を転送

この環境が有効な場合、関連するドメインを持つすべてのフィールドは、フィールドの値の代わりにドメインの説明を使用します。 ドメインを持たないフィールドの値は影響を受けません。

ライセンス情報

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

関連トピック