Skip to main content

NbrRectangle

サマリー

Defines a rectangle neighborhood which is created by specifying the height and the width in either map units or number of cells.

NbrRectangle neighborhoods for FocalStatistics function

NbrRectangle neighborhood examples for the FocalStatistics function.

NbrRectangle neighborhood for BlockStatistics function

NbrRectangle neighborhood example for the BlockStatistics function (width = 6 cells, height = 4 cells).

ディスカッション

Tools that use neighborhood rectangle object: Block Statistics, Focal Statistics, Point Statistics, Point Density, Top Hat Transform, and Topographic Position Index.

ライセンス:

This class is also available if you have an Image Analyst extension license, but only for the Focal Statistics tool.

The rectangle neighborhood is specified by providing a width and a height in either cells or map units.

When rectangle is used in a focal tool the x, y position of the processing cell within the neighborhood is determined, with respect to the upper-left corner of the neighborhood, by the following equations:

\[ \begin{align*} x = (width\ of\ the\ neighborhood + 1) / 2 \\ y = (height\ of\ the\ neighborhood + 1) / 2 \end{align*} \]

If the input number of cells is even, the x,y coordinates are computed using truncation.

Only the cells whose centers fall within the defined object are processed as part of the rectangle neighborhood.

構文

NbrRectangle({width}, {height}, {units})

名前 説明 データ タイプ

width

(オプション)

The width of the rectangle neighborhood.

If only the width is specified, the resulting neighborhood is a square.

The default value is 3.

Double

height

(オプション)

The height of the rectangle neighborhood.

If only the height is specified, the resulting neighborhood is a square.

The default value is 3.

Double

units

(オプション)

Defines the units of the neighborhood.

  • CELL—The unit of measurement is in cells.

  • MAP—The units are in map coordinates.

The default value is CELL.

String

プロパティ

名前 説明 データ タイプ

width

(読み取り/書き込み)

The width of the rectangle neighborhood.

If only the width is specified, the height will default to the same as the width, resulting in a square neighborhood.

Double

height

(読み取り/書き込み)

The height of the rectangle neighborhood.

If only the height is specified, the width will default to the same as the height, resulting in a square neighborhood.

Double

units

(読み取り/書き込み)

Defines the units of the neighborhood.

  • CELL—The units are the number of cells.

  • MAP—The units are in map coordinates.

String

コードのサンプル

NbrRectangle example 1 (Python window)

Demonstrates how to create a NbrRectangle class and use it in the BlockStatistics tool within the Python window.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outNbrRec = BlockStatistics("block", NbrRectangle(4, 5, "MAP"))
outNbrRec.save("C:/sapyexamples/output/blstatsnbrr2")
NbrRectangle example 2 (stand-alone script)

Implements the BlockStatistics tool using the NbrRectangle class.

# Name: NbrRectangle_Ex_02.py
# Description: Uses the NbrRectangle object to run BlockStatistics tool.
# 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 = "block"

# Create the Neighborhood Object
width = 5
height = 6
myNbrRec = NbrRectangle(width, height, "MAP")

# Run BlockStatistics
outBlkStat =  BlockStatistics(inRaster, myNbrRec, "MINIMUM", "DATA")

# Save the output
outBlkStat.save("C:/sapyexamples/output/blstat_rec3")