フォーカル統計 (Spatial Analyst ツール)
サマリー
図
OutRas = FocalStatistics(InRas1, NbrRectangle(3,3,"CELL"), "SUM", "DATA")
使用法
さまざまな近傍の形状と統計の種類から選択できます。 選択できる統計は、入力ラスターのタイプによって異なります。
使用できる近傍形状は、ドーナツ型 (ドーナツまたはリング)、円、四角形、扇形です。 カスタム近傍形状はカーネル ファイルを使用して定義できます。
円形、ドーナツ形、または扇形の近傍が指定された場合、セルの中心は近傍に囲まれている必要があるため、一部の外側の対角セルは、計算に考慮されない場合があります。
近傍 の種類が不規則および加重の場合、カーネル ファイル の値を指定する必要があります。 カーネル ファイルは、近傍の値と形状を指定する ASCII テキスト ファイルです。 ファイルは任意のプレーン テキスト エディターで作成できます。 ファイルには .txt 拡張子を付ける必要があり、ファイル名にスペースを含めることはできません。
カーネル ファイルの作成と使用の詳細については、フォーカル統計の仕組み の不規則と加重のセクションをご参照ください。
整数の入力ラスターの場合、統計の種類 に有効な統計は、最頻値、最大、平均、中央値、最小、最少頻値、パーセンタイル、範囲、標準偏差、合計、および種類です。 浮動小数の入力ラスターの場合、有効な統計は、最大、平均、中央値、最小、パーセンタイル、範囲、標準偏差、および合計です。 浮動小数の入力ラスターでは、最頻値、最少頻値、および種類は使用できません。
入力ラスターが整数の場合、出力ラスターは、最頻値、最大、最小、最少頻値、範囲、合計、および種類で整数になります。 出力値は、平均、中央値、パーセンタイル、および標準偏差で浮動小数になります。
入力ラスターのデータ タイプが浮動小数点数の場合は、使用可能なすべての統計の種類で出力ラスターも浮動小数点数になります。
中央値の計算では、近傍内のセルが奇数の場合、値はランク付けされ、中央の値が中央値として報告されます。 近傍内のセルが偶数の場合は、値はランク付けされ、中央の 2 つの値の平均値が算出されます。
最頻値と最小頻値の計算で、同一頻度の値が複数ある場合の詳細については、「フォーカル統計の仕組み」のトピックをご参照ください。
近傍 パラメーターは、平均 、標準偏差 、および 合計 の統計の種類でのみ 加重 を設定できます。
近傍内のセルのうち最低 1 つが有効な値を持つ場合、計算時に NoData を除外 パラメーターをオンにすると、入力 NoData セルは、出力に値を受け取る場合があります。
このツールに適用されるジオプロセシング環境の詳細については、解析環境と Spatial Analyst をご参照ください。
パラメーター
ラベル
説明
データ タイプ
入力ラスター
各入力セルのフォーカル統計を計算するためのラスター。
Raster Layer
近傍
(オプション)
統計の計算に使用される処理セルを囲むセルです。 さまざまな定義済みの近傍タイプから選択できます。または、カスタム カーネルを定義できます。
近傍タイプを選択すると、他のパラメーターを設定して、計測の形状、サイズ、単位を完全に定義できます。 デフォルトの近傍は、幅と高さが 3 x 3 セルの正方形です。
使用可能な近傍タイプの形式を次に示します。
ドーナツ型 、内部半径 、外部半径 、単位の種類
内径および外径で定義されるリング (ドーナツ形状) の近傍。 半径の最小値は 1 セルで、外径は内径より大きい必要があります。 内径の最大値は 2046 セル、外径の最大値は 2047 セルです。 デフォルトのドーナツ型の内径は 1 セル、外径は 3 セルです。
円形 、半径 、単位の種類
指定した半径の円形の近傍。 半径の最小値は 1 セル、最大値は 2,047 セルです。 デフォルトの半径は 3 セルです。
四角形 、高さ 、幅 、単位の種類
幅と高さで定義される四角形の近傍。 幅または高さの最小値は 1 セル、最大値は 4096 セルです。 デフォルトは、幅と高さが 3 x 3 セルの正方形です。
扇型 、半径 、始点角度 、終点角度 、単位の種類
扇形の近傍は、半径、開始角度、終了角度によって定義されます。 半径の最小値は 1 セル、最大値は 2,047 セルです。 扇形の角度は、反時計回りです。 角度は度で指定し、0 または 360 が東を表します。 負の角度も使用できます。 デフォルトの扇形は 0 〜 90 度で半径は 3 セルです。
不規則 、カーネル ファイル
特定されたカーネル テキスト ファイルで仕様を設定するカスタム近傍です。 カーネルの幅または高さの最小値は 1 セル、最大値は 4096 セルです。
加重 、カーネル ファイル
特定されたカーネル テキスト ファイルで仕様を設定するカスタム近傍です。近傍のメンバーに加重を適用します。 カーネルの幅または高さの最小値は 1 セル、最大値は 4096 セルです。
ドーナツ型、円形、四角形、扇形の近傍タイプの場合、パラメーターの距離単位は、セル 単位または マップ 単位で指定できます。 セル単位がデフォルトです。
カーネル近傍の場合、カーネル ファイルの最初の行は、セル数の近傍の幅と高さを定義します。 次の行は、カーネル内でその位置に対応する入力値の処理方法を示しています。 不規則な近傍または重み付けされた近傍のカーネル ファイルの値が 0 の場合、対応する位置が計算に含まれないことを示しています。 不規則な近傍のカーネル ファイルの値が 1 の場合、対応する入力セルが演算に含まれることを示しています。 重み付けされた近傍の各位置の値は、対応する入力セル値に乗算する数値を示しています。 正の値、負の値、および 10 進数値を使用できます。
Neighborhood
統計の種類
(オプション)
計算する統計の種類を指定します。
デフォルトの統計情報タイプは 平均 です。
入力ラスターが整数の場合、すべての統計の種類が使用できます。 入力ラスターが浮動小数点数の場合、使用できる統計の種類は、平均 、最大 、中央値 、最小 、パーセンタイル 、範囲 、標準偏差 、および 合計 のみです。
平均 近傍のセルの平均値が計算されます。
最頻値 近傍のセルの最頻値 (最も頻繁に発生する値) が特定されます。
最大 近傍のセルの最大値が特定されます。
中央値 近傍のセルの中央値が計算されます。 中央値は 50 番目のパーセンタイルに相当します。
最小 近傍のセルの最小値が特定されます。
最少頻値 近傍のセルの最少頻値 (発生数が最も少ない値) が特定されます。
パーセンタイル 近傍のセルのパーセンタイルが計算されます。 デフォルトでは 90 番目のパーセンタイルが計算されます。 パーセンタイル値 パラメーターを使用して、その他の値 (0 ～ 100) を指定できます。
範囲 近傍のセルの範囲 (最大値と最小値の差) が計算されます。
標準偏差 近傍のセルの標準偏差が計算されます。
合計 近傍のセルの合計値が計算されます。
種類 近傍のセルの種類 (個別値の数) が計算されます。
String
計算時に NoData を除外
(オプション)
統計計算で NoData 値を無視するかどうかを指定します。
オン —近傍内に NoData 値が存在する場合、NoData 値を無視します。 出力値の計算には、近傍内のデータ値を持つセルだけが使用されます。 処理するセル自体が NoData の場合、近傍内のセルのうち最低 1 つが有効な値を持つ処理セルは出力ラスターに値を受け取る場合があります。 これがデフォルトです。
オフ —処理セルを含め、近傍内に NoData 値のセルが存在する場合、処理セルの出力は NoData になります。 NoData 値が存在すると、近傍の統計値を決定するのに十分な情報がないことを意味します。
Boolean
パーセンタイル値
(オプション)
計算するパーセンタイル。 デフォルトは 90 です。これは、90 番目のパーセンタイルです。
値の範囲は 0 〜 100 です。 0 番目のパーセンタイルは、基本的に最小の統計と同じであり、100 番目のパーセンタイルは最大の統計と同じです。 値が 50 の場合、基本的に中央値の統計と同じ結果になります。
このオプションは、統計の種類 パラメーターが パーセンタイル に設定されている場合にのみサポートされます。 その他の統計の種類が指定されている場合、このパラメーターは無視されます。
Double
戻り値
ラベル
説明
データ タイプ
出力ラスター
出力フォーカル統計ラスター。
Raster
FocalStatistics(in_raster, {neighborhood}, {statistics_type}, {ignore_nodata}, {percentile_value})
名前
説明
データ タイプ
in_raster
各入力セルのフォーカル統計を計算するためのラスター。
Raster Layer
neighborhood
(オプション)
統計の計算に使用される処理セルを囲むセルです。 さまざまな定義済みの近傍タイプから選択できます。または、カスタム カーネルを定義できます。
近傍タイプを選択すると、他のパラメーターを設定して、計測の形状、サイズ、単位を完全に定義できます。 デフォルトの近傍は、幅と高さが 3 x 3 セルの正方形です。
近傍の形状は、NeighborhoodNbrAnnulusNbrCircleNbrRectangleNbrWedgeNbrIrregular,、および NbrWeight
使用可能な近傍タイプの形式を次に示します。
NbrAnnulus({innerRadius}, {outerRadius}, {units})
内径および外径で定義されるリング (ドーナツ形状) の近傍。 半径の最小値は 1 セルで、外径は内径より大きい必要があります。 内径の最大値は 2046 セル、外径の最大値は 2047 セルです。 デフォルトのドーナツ型の内径は 1 セル、外径は 3 セルです。
NbrCircle({radius}, {units}
指定した半径の円形の近傍。 半径の最小値は 1 セル、最大値は 2,047 セルです。 デフォルトの半径は 3 セルです。
NbrRectangle({width}, {height}, {units})
幅と高さで定義される四角形の近傍。 幅または高さの最小値は 1 セル、最大値は 4096 セルです。 デフォルトは、幅と高さが 3 x 3 セルの正方形です。
NbrWedge({radius}, {startAngle}, {endAngle}, {units})
扇形の近傍は、半径、開始角度、終了角度によって定義されます。 半径の最小値は 1 セル、最大値は 2,047 セルです。 扇形の角度は、反時計回りです。 角度は度で指定し、0 または 360 が東を表します。 負の角度も使用できます。 デフォルトの扇形は 0 〜 90 度で半径は 3 セルです。
NbrIrregular(inKernelFile)
特定されたカーネル テキスト ファイルで仕様を設定するカスタム近傍です。 カーネルの幅または高さの最小値は 1 セル、最大値は 4096 セルです。
NbrWeight(inKernelFile)
特定されたカーネル テキスト ファイルで仕様を設定するカスタム近傍です。近傍のメンバーに加重を適用します。 カーネルの幅または高さの最小値は 1 セル、最大値は 4096 セルです。
NbrAnnulus、Nbrcircle、NbrRectangle、NbrWedge の近傍の場合、パラメーターの距離単位は CELL 単位または MAP 単位で指定できます。 セル単位がデフォルトです。
カーネル近傍の場合、カーネル ファイルの最初の行は、セル数の近傍の幅と高さを定義します。 次の行は、カーネル内でその位置に対応する入力値の処理方法を示しています。 不規則な近傍または重み付けされた近傍のカーネル ファイルの値が 0 の場合、対応する位置が計算に含まれないことを示しています。 不規則な近傍のカーネル ファイルの値が 1 の場合、対応する入力セルが演算に含まれることを示しています。 重み付けされた近傍の各位置の値は、対応する入力セル値に乗算する数値を示しています。 正の値、負の値、および 10 進数値を使用できます。
Neighborhood
statistics_type
(オプション)
計算する統計の種類を指定します。
デフォルトの統計タイプは MEAN です。
入力ラスターが整数の場合、すべての統計の種類が使用できます。 入力ラスターが浮動小数点数の場合、使用できる統計の種類は、MEAN、MAXIMUM、MEDIAN、MINIMUM、PERCENTILE、RANGE、STD、および SUM のみです。
MEAN近傍のセルの平均値が計算されます。
MAJORITY近傍のセルの最頻値 (最も頻繁に発生する値) が特定されます。
MAXIMUM近傍のセルの最大値が特定されます。
MEDIAN近傍のセルの中央値が計算されます。 中央値は 50 番目のパーセンタイルに相当します。
MINIMUM近傍のセルの最小値が特定されます。
MINORITY近傍のセルの最少頻値 (発生数が最も少ない値) が特定されます。
PERCENTILE近傍のセルのパーセンタイルが計算されます。 デフォルトでは 90 番目のパーセンタイルが計算されます。 percentile_value パラメーターを使用して、その他の値 (0 ～ 100) を指定できます。
RANGE近傍のセルの範囲 (最大値と最小値の差) が計算されます。
STD近傍のセルの標準偏差が計算されます。
SUM近傍のセルの合計値が計算されます。
VARIETY近傍のセルの種類 (個別値の数) が計算されます。
String
ignore_nodata
(オプション)
統計計算で NoData 値を無視するかどうかを指定します。
DATA近傍内に NoData 値が存在する場合、NoData 値を無視します。 出力値の計算には、近傍内のデータ値を持つセルだけが使用されます。 処理するセル自体が NoData の場合、近傍内のセルのうち最低 1 つが有効な値を持つ処理セルは出力ラスターに値を受け取る場合があります。 これがデフォルトです。
NODATA処理セルを含め、近傍内に NoData 値のセルが存在する場合、処理セルの出力は NoData になります。 NoData 値が存在すると、近傍の統計値を決定するのに十分な情報がないことを意味します。
Boolean
percentile_value
(オプション)
計算するパーセンタイル。 デフォルトは 90 です。これは、90 番目のパーセンタイルです。
値の範囲は 0 〜 100 です。 0 番目のパーセンタイルは、基本的に最小の統計と同じであり、100 番目のパーセンタイルは最大の統計と同じです。 値が 50 の場合、基本的に中央値の統計と同じ結果になります。
このオプションは、statistics_type パラメーターが PERCENTILE に設定されている場合のみサポートされます。 その他の統計の種類が指定されている場合、このパラメーターは無視されます。
Double
戻り値
名前
説明
データ タイプ
out_raster
出力フォーカル統計ラスター。
Raster
コードのサンプル
FocalStatistics 例 1 (Python ウィンドウ)
次の例では、入力ラスターの各セルについて、ドーナツ形状の近傍内の最少頻値を計算しています。
import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outFocalStat = FocalStatistics("elevation", NbrAnnulus(5, 10, "CELL"),
"MINORITY", "NODATA")
outFocalStat.save("C:/sapyexamples/output/focalstat01")
FocalStatistics 例 2 (スタンドアロン スクリプト)
次の例では、入力ラスターの各セルについて、10 x 10 の近傍内の最少頻値を判定しています。
# Name: FocalStatistics_Ex_02.py
# Description: Calculates a statistic on a raster over a specified
# neighborhood.
# 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"
neighborhood = NbrRectangle(10, 10, "CELL")
# Run FocalStatistics
outFocalStatistics = FocalStatistics(inRaster, neighborhood, "MINORITY",
"")
# Save the output
outFocalStatistics.save("C:/sapyexamples/output/focalstatout")
環境
自動コミット , セル サイズ , セル サイズ投影法 , 圧縮 , 現在のワークスペース , 範囲 , 地理座標系変換 , マスク , 出力データのコンフィグレーション キーワード , 出力座標系 , 並列処理ファクター , スクラッチ ワークスペース , スナップ対象ラスター , タイル サイズ
ライセンス情報
Basic: Spatial Analyst または Image Analyst が必要
Standard: Spatial Analyst または Image Analyst が必要
Advanced: Spatial Analyst または Image Analyst が必要
