値の計算 (Calculate Value)—ヘルプ

概要
使用法
構文
環境
ライセンス情報

概要

指定した Python 式に基づいて値を返します。

使用法

このツールは、ModelBuilder で使用するためのツールで、Python スクリプトでは使用できません。
ModelBuilder で [データタイプ] パラメーターを使用すると、[値の計算 (Calculate Value)] ツールの出力を他のツールと連結することができます。たとえば、[値の計算 (Calculate Value)] ツールを使用して距離を計算し、この距離を [バッファー (Buffer)] ツールの [バッファー距離] パラメーターへの入力として使用する場合は、[データタイプ] パラメーターの距離単位を指定します。
このツールでは、ModelBuilder で作成しておいた変数を使用できますが、式パラメーター中に使用する対象の変数を [値の計算 (Calculate Value)] ツールに接続することはできません。そのような変数を式中に使用するには、変数名をパーセント記号 (%) で囲まなければなりません。たとえば、「Input」という名前の変数を 100 で除算する場合の式は「%Input%/100」になります。
注意: 上の式で、Input = 123 とした場合に返されるのは、1 です。小数部分の桁数を取得するには、式中の値に小数部分を別途指定します。例: 「%Input%/100.00」と指定した場合は、1.23 が返されます。式中に変数を使用するもう 1 つの例を、下の図に示します。
注意:
式中で、文字列型のインライン変数は、引用符で囲む必要があります (「"%string variable%"」のように指定します)。インライン変数が数値 (double、long) 型なら、引用符は必要ありません (「%double%」のように指定すれば済みます)。
式の作成には、Python しか使用できません。それ以外のスクリプト言語はサポートされていません。
[値の計算 (Calculate Value)] ツールで評価の対象となるのは、簡易な算術式です。以下に例を示します。
- 3+5
- 9*8
- 4+(9/3)
[値の計算 (Calculate Value)] ツールでは、Python の math モジュールを使用することによって、複雑な数値演算の実行を実現しています。math モジュールにアクセスするには、使用する関数の先頭に「math」を付けます。以下に例を示します。
- math.sqrt(25)
- math.cos(0.5)
定数も math モジュールを介してサポートされます。例:
- math.pi
arcgis.rand() 関数はサポートの対象です。arcgis.rand() 関数は ArcGIS ツール用に作成されたものであり、Python Rand() 関数と混同しないようにしてください。以下は、arcgis.rand() の使用例です。
- 0 から 10 までの整数の一様分布から派生したランダム値の演算: arcgis.rand("Integer 0 10")
- 平均値が 10、標準偏差が 3 の正規分布から派生したランダム値の演算: arcgis.rand("Normal 10 3")
注意:
式 arcgis.rand は、小文字で入力する必要があります。
通常は、[条件式] パラメーターで式を入力します。複数行の計算や論理演算 (if、then) などの複雑な式を入力する場合は、[コードブロック] パラメーターを使用する必要があります。[コードブロック] パラメーターは単独では使用できません。[条件式] パラメーターと併用する必要があります。
[コードブロック] パラメーターで定義しておいた変数は、式から参照できます。
関数は [コードブロック] パラメーターで定義して、式から呼び出せます。下の例では、ランダムな入力値に応じた、風向を示す文字列が関数によって返されます。Python では、def キーワードの後に関数の名前と関数の入力パラメーターを付けて、関数を定義します。この例で、関数は getWind であり、パラメーターとして指定されているのは 1 つ (wind) だけです。値を関数から返すには、return キーワードを使用します。
[条件式] パラメーターを介して変数を渡し、[コードブロック] でインライン変数を指定して if-else ロジックを使用することができます (次の図を参照)。[コードブロック] では、InputCellSize 変数が空であるかどうかのチェックが実行された後、条件に基づいて値が返されます。
Python のメソッドは、このツールの [条件式] パラメーターで直接使用できます。たとえば、入力値に小数部分 (この例では、入力テーブルのフィールド値) があり、その小数部分の値をインライン変数置換で別のツールの出力名に含める場合は、[値の計算 (Calculate Value)] ツールの [条件式] で Python メソッド replace を使用して小数部分を置換することができます。
[コードブロック] パラメーターでは、Python モジュールを呼び出し、replace などのメソッドを結合またはスタックできます。下の例では、[コードブロック] に time モジュールをインポートして、「Fri Mar 19 2010 09:42:39」のような現在の日付と時刻が返されるようにしています。この戻り値は、[フォルダーの作成 (Create Folder)] ツールでフォルダーに名前を付けるために使用されます。フォルダーの名前にはスペースまたは句読点を含めることができないので、置換の必要なエレメントごとにメソッドをスタックして、Python の replace メソッドを使用しなければなりません。この例で、結果として得られるフォルダーの名前は「FriMar192010094239」です。
モデル内で値の計算を行う際に、バッファー距離値と距離単位を必要とする [バッファー (Buffer)] などのツールで、算出された値を使用する場合は、次の操作を実行する必要があります。
- 距離値と一緒に [コードブロック] の距離単位を返す。
- 次に示すように、返された値のデータタイプを変更する。
- 式の結果が距離単位の値に変換されるように、データタイプのパラメーターを距離単位に設定する。
[値の計算 (Calculate Value)] ツールの出力は、[Plus]、[Greater Than]、[Less Than] など、ラスターまたは定数値を受け入れる [Spatial Analyst] ツールで直接使用することができます (これらのツールは、[Spatial Analyst] ツールボックスまたは [算術演算] ツールセットに用意されています)。[値の計算 (Calculate Value)] の出力を使用するには、出力データタイプを [構築されたラスター] に変更します。この出力データタイプ形式は、セル値が数式または定数で表されるラスターサーフェスです。
Python では、適切なインデントも構文の一部です。インデントレベル (スペース 2 つまたはスペース 4 つ) は、[コードブロック] 全体にわたって一貫している限り、問題にはなりません。
モデル変数は、[コードブロック] からはアクセスできません。そのような変数は、式を介して [コードブロック] に受け渡す必要があります。この受け渡しを行うには、[コードブロック] パラメーターで定義を作成し、その定義を [条件式] パラメーターで参照します。
リストタイプのモデル変数は、[条件式] パラメーターで使用しないでください。ModelBuilder でのリスト変数の動作の仕組み上、[値の計算 (Calculate Value)] はリスト変数の最初の値を使用して一度実行され、リスト変数のその他の値は [値の計算 (Calculate Value)] に渡されません。

構文

CalculateValue(expression, {code_block}, {data_type})

パラメーター	説明	データタイプ
expression	評価される Python 式。	SQL Expression
code_block (オプション)	追加の Python コード。コードブロックのコードは [条件式] パラメーターで参照できます。	String
data_type (オプション)	Python 式から返された出力のデータタイプ。[値の計算 (Calculate Value)] を他のツールと連結するためには、このパラメーターを ModelBuilder で使用する必要があります。	String

派生した出力

名前	説明	データタイプ
value

環境

このツールは、ジオプロセシング環境を使用しません。

ライセンス情報

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

ArcMap

値の計算 (Calculate Value)

概要

使用法

構文

派生した出力

環境

ライセンス情報

関連トピック