マスクで抽出 (Extract by Mask) (Spatial Analyst)

サマリー

マスクによって定義されたエリアに一致するラスターのセルを抽出します。

図

OutRas = ExtractByMask(InRas1, InMsk1, "INSIDE")

使用法

• 入力ラスターからの追加属性 (存在する場合) は、そのまま出力ラスター属性テーブルに引き継がれます。 記録されるプロパティに応じて、一部の属性値は再計算が必要な場合があります。

• [入力ラスター] (Python では in_raster) の値としてマルチバンド ラスターが指定された場合、すべてのバンドが使用されます。

  マルチバンド ラスターから選択したバンドを処理するには、まず、[コンポジット バンド (Composite Bands)] ツールを使用して、それら特定のバンドから構成されるラスター データセットを作成します。 次に、その結果を [入力ラスター] (Python では in_raster) の値として使用します。

  デフォルトの出力形式は、ジオデータベース ラスターです。 出力形式として Esri Grid スタックを指定した場合、スタックの名前を数字で開始したり、名前にスペースを使用したり、9 文字を超える名前にしたりすることはできません。

• 入力ラスター マスクにマルチバンド ラスターが指定された場合、最初のバンドだけが処理に使用されます。

• [入力ラスター] (Python では in_raster) の値と [入力ラスター マスク、またはフィーチャ マスク データ] データ (Python では in_mask_data) のセル サイズが同じで、セルが位置揃えされている場合、それらはツールで直接使用されます。 ツールの実行時に内部でリサンプリングされません。

  セル サイズが異なる場合、出力セル サイズは入力の最大値になり、[入力ラスター] の値は内部でスナップ対象ラスターとして使用されます。 セル サイズは同じだが、セル同士が位置揃えされていない場合、[入力ラスター] の値が内部でスナップ対象ラスターとして使用されます。 これらの場合、抽出操作が実行される前に、内部でリサンプリングが開始されます。

  詳細については、「セル サイズ」と「スナップ対象ラスター」の環境トピックをご参照ください。

• マスク入力がフィーチャである場合、デフォルトの [入力ラスター] 値からのセル サイズとセルの配置 (スナップ対象ラスター) を使用して、内部でラスターに変換されます。

• [マスクで抽出 (Extract by Mask)] ツールの実行中に環境設定でマスクが指定されている場合、出力ラスターは、環境マスクと入力マスク データの交差部分内にあるエリアのセル値のみを持ちます。

• [解析の範囲] (Python では analysis_extent) パラメーターを使用すると、スタンドアロン ツールの操作に対して出力解析エリアを明示的に指定したり、ワークフローの一環として環境設定を上書きしたりできます。 値の入力、表示範囲の選択、レイヤーの選択、入力データセットの参照によって、範囲を指定できます。

• デフォルトの [解析の範囲] 値は、[入力ラスター] 値と [入力ラスター、またはフィーチャ マスク データ] 値の交差部分から算出されます。

• 解析の範囲がパラメーター値として明示的に指定されていない場合は、解析の環境設定から取得されます。

• このツールに適用されるジオプロセシング環境の詳細については、「解析環境と Spatial Analyst」をご参照ください。

パラメーター

ダイアログ

ラベル	説明	データ タイプ
入力ラスター	セルを抽出する入力ラスター。	Raster Layer
入力ラスター、またはフィーチャ マスク データ	抽出するセルの位置を定義する入力マスク データ。 これは、ラスターでもフィーチャ データセットでもかまいません。 入力マスク データがラスターの場合、マスク上の値が NoData であるセルは出力ラスターでも NoData が割り当てられます。 入力マスクがフィーチャ データである場合、フィーチャの指定形状内に中心がある入力ラスター内のセルが出力に含められます。中心が外部にあるセルは、NoData になります。	Raster Layer; Feature Layer
抽出エリア (オプション)	入力マスクによって定義された位置の内部のセルと外部のセルのどちらを選択して、出力ラスターに書き込むかを指定します。 内側—入力マスクの内部のセルを選択して、出力ラスターに書き込みます。 外部にあるすべてのセルは、出力ラスターでは値が NoData になります。 これはデフォルトです。 外側—入力マスクの外部のセルを選択して、出力ラスターに書き込みます。 マスクでカバーされるすべてのセルは NoData になります。	String
分析範囲 (オプション)	抽出するエリアを定義する範囲。 デフォルトでは、範囲は [入力ラスター] 値と [入力ラスター、またはフィーチャ マスク データ] 値の交差部分として計算されます。 処理は X および Y の制限内で実行され、この範囲の外にあるセルは NoData になります。 座標は、解析によって明示的に設定されていない場合、入力ラスターと同じマップ単位で指定します。 [現在の表示範囲] - 範囲は、アクティブなマップまたはシーンに基づきます。 このオプションは、アクティブなマップが存在する場合にのみ使用できます。 [範囲の描画] - 範囲は、マップまたはシーンに描画された四角形に基づきます。 このオプションは、プロジェクト ジオデータベースにフィーチャクラスを作成し、レイヤーをマップに追加します。 フィーチャクラスの座標系はマップと同じです。 注意: このオプションは、[環境] ダイアログ ボックスでは使用できません。 範囲データ タイプを使用するツール パラメーターまたはツール ダイアログ ボックスの [環境] タブからのみ使用できます。 注意: 編集タブで編集を有効/無効にする編集オプションがオンの場合、範囲を描画するには [編集] リボン タブで編集を有効化する必要があります。 [レイヤーの範囲] - 範囲は、アクティブなマップ レイヤーに基づきます。 ドロップダウン リストを使用して使用可能なレイヤーを選択するか、[すべてのレイヤーのデータの範囲] オプションを使用して、ベースマップを除くすべてのアクティブなマップ レイヤーを組み合わせた範囲を取得します。 このオプションは、レイヤーを含むアクティブなマップが存在する場合にのみ使用できます。 各マップ レイヤーには、次のオプションがあります。 [すべてのフィーチャ] - レイヤーのすべてのフィーチャの範囲。 [選択フィーチャ] - レイヤーの選択フィーチャの範囲。 [表示フィーチャ] - レイヤーの表示フィーチャの範囲。 注意: [選択フィーチャ] と [表示フィーチャ] オプションの範囲は、フィーチャ レイヤーでのみ使用できます。 [参照] - 範囲は、既存のデータに基づきます。 [クリップボード] - 範囲をクリップボードにコピーしたり、クリップボードから貼り付けたりできます。 [範囲をコピー] - 範囲の座標と座標系をクリップボードにコピーします。 [範囲を貼り付け] - 範囲の座標と、必要に応じて座標系をクリップボードから貼り付けます。 クリップボードの値に座標系が含まれていない場合、マップの座標系が範囲に使用されます。 注意: 範囲の座標は、ArcPy Extent オブジェクトと同じ書式と順序 (x-min、y-min、x-max、y-max、空間参照) を使用して、クリップボードからコピーおよびクリップボードから貼り付けられます。 [範囲をリセット] - 範囲はデフォルト値にリセットされます。 手動入力した座標値 - 座標値は数値であり、アクティブなマップの座標系で表示する必要があります。 注意: マップで、入力された座標と異なる表示単位が使用されることがあります。 基本方向 (N、S、E、W) を使用することはできません。 南と西の座標にはマイナス値の記号を使用します。	Extent

戻り値

ラベル	説明	データ タイプ
出力ラスター	入力ラスターから抽出したセル値が格納される出力ラスター。	Raster

Python

ExtractByMask(in_raster, in_mask_data, {extraction_area}, {analysis_extent})

名前	説明	データ タイプ
in_raster	セルを抽出する入力ラスター。	Raster Layer
in_mask_data	抽出するセルの位置を定義する入力マスク データ。 これは、ラスターでもフィーチャ データセットでもかまいません。 入力マスク データがラスターの場合、マスク上の値が NoData であるセルは出力ラスターでも NoData が割り当てられます。 入力マスクがフィーチャ データである場合、フィーチャの指定形状内に中心がある入力ラスター内のセルが出力に含められます。中心が外部にあるセルは、NoData になります。	Raster Layer; Feature Layer
extraction_area (オプション)	入力マスクによって定義された位置の内部のセルと外部のセルのどちらを選択して、出力ラスターに書き込むかを指定します。 INSIDE—入力マスクの内部のセルを選択して、出力ラスターに書き込みます。 外部にあるすべてのセルは、出力ラスターでは値が NoData になります。 これはデフォルトです。 OUTSIDE—入力マスクの外部のセルを選択して、出力ラスターに書き込みます。 マスクでカバーされるすべてのセルは NoData になります。	String
analysis_extent (オプション)	抽出するエリアを定義する範囲。 指定されない場合、デフォルトの範囲は、in_raster 値と in_mask_data 値の交差部分です。 座標は、解析によって明示的に設定されていない場合、入力ラスターと同じマップ単位で指定します。 MAXOF - すべての入力データの最大範囲が使用されます。 MINOF - すべての入力データに共通する最小領域が使用されます。 DISPLAY - 範囲は、表示範囲と同じになります。 レイヤー名 - 指定したレイヤーの範囲が使用されます。 Extent オブジェクト - 指定したオブジェクトの範囲が使用されます。 座標のスペース区切りの文字列 - 指定した文字列の範囲が使用されます。 座標は、x-min、y-min、x-max、y-max の順序で表されます。	Extent

戻り値

名前	説明	データ タイプ
out_raster	入力ラスターから抽出したセル値が格納される出力ラスター。	Raster

コードのサンプル

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

次の例では、入力ポリゴン シェープファイルのフィーチャクラスによって定義されたマスク内にあるラスターから、セルを抽出しています。

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outExtractByMask = ExtractByMask("elevation", "mask.shp", "INSIDE")
outExtractByMask.save("C:/sapyexamples/output/maskextract")

ExtractByMask の例 2 (スタンドアロン スクリプト)

次の例では、入力ポリゴン シェープファイルのフィーチャクラスによって定義されたマスク外のすべてのエリアのラスターから、セルを抽出し、入力ラスターの出力範囲を維持します。

# Name: ExtractByMask_Ex_02.py
# Description: Extracts the cells of a elevation raster for all areas outside of the mask features.
#     Keeping the output extent of the input elevation raster. 
# Requirements: Spatial Analyst Extension

# Import system modules
import arcpy
from arcpy import env
from arcpy.sa import *

# Set environment settings
env.workspace = "C:/sapyexamples/data"

# Set local variables
inRaster = "elevation"
inMaskData = "mask.shp"
extraction_area = "OUTSIDE"
analysis_extent = "elevation"


# Execute ExtractByMask
outExtractByMask = ExtractByMask(inRaster, inMaskData, extraction_area, analysis_extent)

# Save the output 
outExtractByMask.save("C:/sapyexamples/output/extractmask")

環境

自動コミット, セル サイズ, セル サイズ投影法, 圧縮, 現在のワークスペース, 範囲, 地理座標系変換, マスク, 出力データのコンフィグレーション キーワード, 出力座標系, テンポラリ ワークスペース, スナップ対象ラスター, タイル サイズ