サマリー
Environment settings are exposed as properties on the env class. Geoprocessing environment settings can be thought of as additional parameters that affect a tool's results.
説明
Starting at ArcGIS Pro 2.9, setting an invalid environment name will fail with an AttributeError exception.
プロパティ
| プロパティ | 説明 | データ タイプ |
| addOutputsToMap (読み書き) | Specifies whether the output datasets will be added to the application display. This property is only applicable when used directly in the Python window or from a notebook in ArcGIS Pro. | Boolean |
| annotationTextStringFieldLength (読み書き) | アノテーションのテキスト文字列フィールドの長さ環境に従うツールは、データベースで作成されたすべてのアノテーション フィーチャクラスの TextString フィールドでデフォルトのフィールド長をオーバーライドします。 | Long |
| autoCancelling (読み書き) | Specifies whether a cancellation will end the script on the current line. If True, a cancellation will end the script. If False, a cancellation will set the isCancelled property to True and continue running. The default is True. Use in script tools or Python toolbox tools. | Boolean |
| autoCommit (読み書き) | 自動コミット環境を反映するツールは、エンタープライズ ジオデータベース トランザクション内で指定された回数の変更が行われた後に、強制的にコミットを実行します。 | Long |
| baDataSource (読み書き) | 一方のレイヤーから他方のレイヤーにデータを集計する方法に従ってデータ ソース環境設定を反映するツールです。 この環境は、Business Analyst ツールにのみ使用されます。 | String |
| baNetworkSource (読み書き) | ネットワーク ソース環境を優先するツールで、ネットワーク距離計算タスクで使用するデータセットまたはサービスを設定できます。これは、Business Analyst ツールにのみ使用されます。 | String |
| baUseDetailedAggregation (読み書き) | 詳細な設定の使用の環境に適合するツールでは、指定された半径を超えた面積の詳細なデータ集計方法が使用されます。 この環境は、Business Analyst ツールにのみ使用されます。 | Boolean |
| buildStatsAndRATForTempRaster (読み書き) | Specifies whether statistics will be calculated and raster attribute tables (RAT) will be built for temporary rasters created by Spatial Analyst tools. The environment is only used from the interactive Python window in the application. The default is True. When set to False, the statistics will be approximate for the purpose of symbolizing raster layers, and no RAT will be built. | Boolean |
| cartographicCoordinateSystem (読み書き) | カートグラフィの座標系の環境を反映するツールは、計算時に、フィーチャのサイズ、範囲、および空間リレーションシップを決定するために、指定された座標系を使用します。 | String |
| cartographicPartitions (読み書き) | カートグラフィック パーティション環境を反映するツールは、指定した分割ポリゴン フィーチャを基準にして入力フィーチャを分割し、連続した処理を行えるようにします。この処理によって、大きなデータセットで起きる可能性のある、メモリの制限を防ぐことができます。 | String |
| cellSize (読み書き) | セル サイズ環境を反映するツールは、操作で使用する出力ラスター セル サイズ、または解像度を設定します。 デフォルトの出力解像度は、入力ラスター データセットの最も粗い解像度で決まります。 | String |
| cellSizeProjectionMethod (読み書き) | セル サイズ投影法環境を反映するツールは、解析中にデータセットが投影変換されるときに、出力ラスターのセル サイズの計算に指定された方法を使用します。 | String |
| coincidentPoints (読み書き) | コインシデント ポイント環境を適用するツールは、Geostatistical Analyst での一致データの扱い方を定義します。 | String |
| compression (読み書き) | 圧縮の環境を反映するツールを実行すると、出力ラスター データセットを格納する際の圧縮タイプが設定されます。 | String |
| configKeyword (読み書き) | 出力データのコンフィグレーション キーワードの環境を反映するツールは、ジオデータベースにデータセットを作成するときに、指定されたキーワードを使用します。 | String |
| daylightSaving (読み書き) | サマータイムを調整環境を優先するツールは、サマー タイムを示すように日付フィールドのタイム ゾーンの値を調整します。 | Boolean |
| extent (読み書き) | 範囲の環境を反映するツールは、この設定で指定された範囲内のフィーチャまたはラスターだけを処理します。 | String |
| geographicTransformations (読み書き) | 地理座標系変換の環境を反映するツールは、データを投影するときに、この変換方法を使用します。 | String |
| gpuId (読み書き) | GPU ID の環境を反映するツールは、データ処理に使用する GPU を特定します。 | Long |
| isCancelled (読み取り専用) | When autoCancelling is set to False and the tool has been cancelled, isCancelled will be set to True. isCancelled is False by default and is a read-only property. Use this property in script tools or Python toolbox tools. | Boolean |
| maintainAttachments (読み書き) | アタッチメントの保持環境設定を優先するツールは、入力フィーチャのアタッチメントを出力フィーチャにコピーします。 アタッチメント テーブルとリレーションシップ クラスが作成されます。 | Boolean |
| maintainCurveSegments (読み書き) | 曲線セグメントの維持の環境が入力曲線セグメントを出力でも維持することを考慮するツールです。 | Boolean |
| maintainSpatialIndex (読み書き) | レガシー:空間インデックスの保持環境設定は、ArcGIS Pro ではサポートされていません。 エンタープライズ ジオデータベース内の既存のデータに対して挿入、更新、および削除操作を行うツールやワークフローを実行する場合に ArcGIS Pro で空間インデックスの保持環境設定と同じ動作を実現するには、[空間インデックスの削除 (Remove Spatial Index)] ツールを使用して処理前に空間インデックスを削除し、[空間インデックスの追加 (Add Spatial Index)] ツールを使用して処理後に空間インデックスを再作成することで、空間インデックスを制御します。 ファイル ジオデータベースのデータを使用している場合、[アペンド (Append)] ツールでもこのワークフローが実行されます。 | Boolean |
| mask (読み書き) | マスク環境を反映するツールは、操作中、解析マスク内に含まれるセルだけを対象にします。 | String |
| matchMultidimensionalVariable (読み書き) | 多次元変数の照合の環境を反映するツールは、入力多次元ラスターが同じ名前の変数を少なくとも 1 つ共有する場合にのみ、多次元ラスターを生成します。 | String |
| MDomain (読み書き) | 出力データの M ドメインの環境を反映するツールは、指定されたメジャー ドメイン (M ドメイン) で出力データセットを作成します。 | String |
| MResolution (読み書き) | M 座標精度の環境を反映するツールは、M 座標精度を出力ジオデータセットに適用します。 M 座標精度とは、M 値を格納するために使用される有効桁数を指し、非常に短い距離として表されます。 | Double |
| MTolerance (読み書き) | M 許容値の環境を反映するツールは、ジオデータベース内に作成されたジオデータセットのデフォルトの M 許容値を無視します。 | Double |
| nodata (読み書き) | NoData の環境を反映するツールは、NoData 値が有効なラスターのみを処理します。 | String |
| outputCoordinateSystem (読み書き) | 出力データの座標系の環境を反映するツールは、指定された座標系で出力ジオデータセットを作成します。 | String |
| outputMFlag (読み書き) | 出力データに M 値を含む環境を反映するツールは、出力ジオデータセットが M 値を格納するかどうかを制御します。 | String |
| cellAlignment (読み書き) | セルの配置環境を反映するツールは、出力のセルの配置を調整して、指定した処理範囲のセルの配置に一致させます。 | String |
| outputZFlag (読み書き) | 出力データに Z 値を含む環境を反映するツールは、出力ジオデータセットが Z 値を格納するかどうかを制御します。 | String |
| outputZValue (読み書き) | 出力データのデフォルト Z 値の環境を反映するツールは、Z 座標値を持たない出力頂点ごとに Z 座標値を設定します。 | String |
| overwriteOutput (読み書き) | Specifies whether tools will automatically overwrite any existing output when run. When set to True, tools will run and overwrite the output dataset. When set to False, existing outputs will not be overwritten, and the tool will return an error. | Boolean |
| packageWorkspace (読み取り専用) | パッケージ ワークスペース環境設定は、共有ジオプロセシング パッケージまたはサービスのコンテンツがあるフォルダーの場所です。 | String |
| parallelProcessingFactor (読み書き) | 並列処理ファクター環境を考慮するツールでは、複数のプロセスにまたがる処理が分割されて実行されます。 | Integer |
| processingServer (読み書き) | ラスター プロセシング システム サービスが有効になっている ArcGIS サーバーの名前または IP アドレス。 リモート処理サーバーの環境の設定を優先するツールは、並列処理ファクターの環境を使用する際、ArcGIS Server のサーバー、ユーザー名、パスワードを指定します。 | String |
| processingServerPassword (読み書き) | ラスター処理サービスを使用する権限のあるユーザーの名前に関連付けられたパスワード。 リモート処理サーバーの環境の設定を優先するツールは、並列処理ファクターの環境を使用する際、ArcGIS Server のサーバー、ユーザー名、パスワードを指定します。 | String |
| processingServerUser (読み書き) | ラスター プロセシング サービスを使用する権限のあるユーザーの名前。 リモート処理サーバーの環境の設定を優先するツールは、並列処理ファクターの環境を使用する際、ArcGIS Server のサーバー、ユーザー名、パスワードを指定します。 | String |
| processorType (読み書き) | プロセッサ タイプの環境を反映するツールを使用すると、データを処理する場所と方法を選択できます。 | Long |
| pyramid (読み書き) | ピラミッドの環境を反映するツールは、ピラミッドが有効なラスターのみを処理します。 ERDAS IMAGINE ファイルのピラミッドでは、設定可能なオプションが限定されます。 | String |
| qualifiedFieldNames (読み書き) | 修飾されたフィールド名を保持する環境を反映するツールは、この設定を使用して修飾されたフィールド名と非修飾フィールド名を区別します。 修飾されたフィールド名は、元のフィーチャクラスまたはテーブルの名前がフィールド名に付加された、フィーチャクラスまたはテーブル内のフィールドの名前です。 この設定が適切なのは、結合されたデータを操作するときです。 | Boolean |
| randomGenerator (読み書き) | 乱数ジェネレーターの環境を反映するツールは、シードと分布を使用するアルゴリズムを使用して一連の乱数を生み出します。 | Object |
| rasterStatistics (読み書き) | ラスターの統計情報の環境を反映するツールは、出力ラスター データセットの統計情報の作成方法を制御します。 | String |
| recycleProcessingWorkers (読み書き) | 処理ワーカーのリサイクル間隔の環境が、長時間のプロセスで発生の可能性がある障害を回避するため、ワーカー プロセスを再開する前に処理する画像セクションの数を定義することを考慮するツールです。 | Long |
| referenceScale (読み書き) | 基準縮尺の環境を反映するツールは、シンボル表示されたフィーチャが基準縮尺で表示されたときのグラフィカル サイズと範囲を考慮します。 | Double |
| resamplingMethod (読み書き) | Resampling Method 環境を適用するツールは、ラスター データセットの変換中にピクセル値を内挿します。 入力と出力が正確に対応していない場合、ピクセル サイズが変わる場合、データがシフトされる場合などにこの方法を使用します。 | String |
| retryOnFailures (読み書き) | 障害時の再試行回数環境を優先するツールは、特定ジョブの処理中に障害が発生したときに、同じワーカー プロセスを指定した試行回数だけ再試行します。 | Long |
| scratchFolder (読み取り専用) | テンポラリ フォルダー環境設定は、シェープファイル、テキスト ファイル、レイヤー ファイルなど、ファイルベースのデータを書き込むことができるフォルダーの場所です。 | String |
| scratchGDB (読み取り専用) | テンポラリ GDB の環境設定は、テンポラリ データを書き込むことができるファイル ジオデータベースの場所です。 | String |
| scriptWorkspace (読み取り専用) | スクリプト ワークスペースはプロジェクトの場所です。これは、プロジェクト パッケージ (.ppkx ファイル) に含まれているジオプロセシング ツールが抽出された場合に、ジオプロセシング ツールで使用されます。 | String |
| scratchWorkspace (読み書き) | テンポラリ ワークスペースの環境を反映するツールは、出力データセットのデフォルトのワークスペースとして指定された場所を使用します。 テンポラリ ワークスペースは、保守しない出力データ向けです。 | String |
| snapRaster (読み書き) | スナップ対象ラスターの環境を反映するツールは、出力ラスターの範囲を調整して、指定したスナップ対象ラスターのセルの配置に一致させます。 | String |
| S100FeatureCatalogueFile (読み書き) | S-100 フィーチャ カタログ ファイルの環境を反映するツールは、データをインポートし、データベース スキーマを生成する際にマップ オブジェクト、属性、フィーチャクラス、およびリレーションシップに指定されたファイルを使用します。 | String |
| terrainMemoryUsage (読み書き) | テレイン環境での解析でメモリ使用を最小化するツールは、テレインの解析中のメモリ使用量を制御します。 | Boolean |
| tileSize (読み書き) | タイル サイズの環境を反映するツールは、データのブロックに格納されるラスターのタイル サイズを設定します。 | String |
| timeZone (読み書き) | タイム ゾーン環境を反映するツールは、日付フィールドが格納されるタイム ゾーンを指定します。 | String |
| tinSaveVersion (読み書き) | デフォルトの TIN 格納バージョンの環境を尊重するツールは、指定したバージョンで TIN サーフェスを出力します。 | String |
| transferDomains (読み書き) | フィールド ドメインの説明を転送の環境を適用するツールは、ドメインとサブタイプのコードを含むフィールドとともに、ドメインとサブタイプの説明を含むフィールドも出力に含めるかどうかを制御します。 この設定は、ジオプロセシング ツールへの入力が、ドメインとサブタイプが定義されているジオデータベースのフィーチャクラスまたはテーブルである場合に適用されます。 | Boolean |
| transferGDBAttributeProperties (読み書き) | ジオデータベース フィールド プロパティの転送の環境を反映するツールは、ドメイン、サブタイプ、属性ルール、フィールド グループ、および条件値を入力データセットのフィールドから出力データセットのフィールドに転送します。 | Boolean |
| unionDimension (読み書き) | ディメンションの結合環境を反映するツールは、入力多次元ラスターのすべてのディメンションを含む多次元ラスターを生成します。 | Boolean |
| useCompatibleFieldTypes (読み書き) | Specifies whether field types that are compatible with ArcGIS Pro 3.1 will be used. This setting relates to the use of the Date Only, Time Only, Timestamp Offset, and Big Integer field types in CSV tables and unregistered database tables with tools that create layers or table views. When set to True, a layer or table view created from these sources will use field types compatible with ArcGIS Pro 3.1. Date Only, Time Only, and Timestamp Offset fields will be displayed as Date fields, and Big Integer fields will be displayed as Double fields. When set to False, all original data source field types will be used. 注意:This property is applicable when used from stand-alone Python or for a geoprocessing service. When used in ArcGIS Pro, this property will always match the Use field types that are compatible with ArcGIS Pro 3.1 and earlier releases when adding query layers and text files option. | Boolean |
| workspace (読み書き) | 現在のワークスペースの環境を反映するツールは、ジオプロセシング ツールの入力と出力のデフォルトの場所として指定されたワークスペースを使用します。 | String |
| XYDomain (読み書き) | 出力データの XY ドメインの環境を反映するツールは、指定された範囲を出力ジオデータセットの XY ドメインに設定します。 | String |
| XYResolution (読み書き) | XY 座標精度の環境を反映するツールは、X,Y 座標精度を出力ジオデータセットに適用します。 XY 座標精度とは、XY 座標値を格納するために使用される有効桁数を指し、非常に短い距離として表されます。 | String |
| XYTolerance (読み書き) | XY 許容値の環境を反映するツールは、ジオデータベース内に作成されたジオデータセットのデフォルトの X,Y 許容値を無視します。 | String |
| ZDomain (読み書き) | 出力データの Z ドメインの環境を反映するツールは、指定された Z ドメインで出力データセットを作成します。 | String |
| ZResolution (読み書き) | Z 座標精度の環境を反映するツールは、Z 座標精度を出力ジオデータセットに適用します。 Z 座標精度とは、Z 座標値を格納するために使用される有効桁数を指し、非常に短い距離として表されます。 | String |
| ZTolerance (読み書き) | Z 許容値の環境を反映するツールは、ジオデータベース内に作成されたジオデータセットのデフォルトの Z 許容値を無視します。 | String |