Extract by Rectangle (Spatial Analyst)

Available with Spatial Analyst license.

Summary

Extracts the cells of a raster based on a rectangle by specifying the rectangle's extent.

Illustration

OutRas = ExtractByRectangle(InRas1, Extent(1, 0, 5, 5), "INSIDE")

Usage

• Additional attributes from the input raster, if any, will be carried over as-is to the output raster attribute table. Depending on the property being recorded, some of the attribute values may need to be recalculated.

• When a multiband raster is specified as the Input Raster (in_raster in Python), all bands will be used.

  To process a selection of bands from a multiband raster, first create a new raster dataset composed of those particular bands using the Composite Bands tool. Then use the result as the Input Raster (in_raster in Python).

  The default output format is a geodatabase raster. If an Esri Grid stack is specified as the output format, the name of the stack cannot start with a number, use spaces, or be more than nine characters in length.

• The center of the cell is used to determine whether a cell is inside or outside a rectangle. If the center is within the outline of a rectangle, the cell is considered fully inside even if portions of the cell fall outside the rectangle.

• Cell locations that are not selected are assigned a value of NoData.

• If the input raster is integer, the output raster will be integer. If the input is floating point, the output will be floating point.

• See Analysis environments and Spatial Analyst for additional details on the geoprocessing environments that apply to this tool.

Parameters

Dialog

Label	Explanation	Data Type
Input raster	The input raster from which cells will be extracted.	Raster Layer
Extent	A rectangle that defines the area to be extracted. If the Extent parameter is set to As Specified Below, use the parameters identified with the left and down arrows define the lower-left coordinate of the area to be extracted, and those with the right and up arrows to define the upper-right coordinate. If the Extent parameter is set to Browse, you can select a dataset whose bounding box will define the extent. The coordinates are specified in the same map units as the input raster.	Extent
Extraction area (Optional)	Identifies whether to extract cells inside or outside the input rectangle. Inside — A keyword specifying that the cells inside the input rectangle should be selected and written to the output raster. All cells outside the rectangle will receive NoData values on the output raster. Outside — A keyword specifying that the cells outside the input rectangle should be selected and written to the output raster. All cells inside the rectangle will receive NoData values on the output raster.	String

Return Value

Label	Explanation	Data Type
Output raster	The output raster containing the cell values extracted from the input raster.	Raster

Python

ExtractByRectangle(in_raster, rectangle, {extraction_area})

Name	Explanation	Data Type
in_raster	The input raster from which cells will be extracted.	Raster Layer
rectangle extent	A rectangle that defines the area to be extracted. An Extent object is used to specify the coordinates. The form of the object is: Extent(XMin, YMin, XMax, YMax) where XMin and YMin define the lower-left coordinates of the area to be extracted, and XMax and YMax define the upper-right coordinates. The coordinates are specified in the same map units as the input raster.	Extent
extraction_area (Optional)	Identifies whether to extract cells inside or outside the input rectangle. INSIDE — A keyword specifying that the cells inside the input rectangle should be selected and written to the output raster. All cells outside the rectangle will receive NoData values on the output raster. OUTSIDE —A keyword specifying that the cells outside the input rectangle should be selected and written to the output raster. All cells inside the rectangle will receive NoData values on the output raster.	String

Return Value

Name	Explanation	Data Type
out_raster	The output raster containing the cell values extracted from the input raster.	Raster

Code sample

ExtractByRectangle example 1 (Python window)

This example extracts cells outside a rectangular extent to a new raster.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
rectExtract = ExtractByRectangle("elevation", 
                                 Extent(477625, 213900, 486400, 224200), 
                                 "OUTSIDE")
rectExtract.save("c:/sapyexamples/output/extrect")

ExtractByRectangle example 2 (stand-alone script)

This example extracts cells inside a rectangular extent to a new raster.

# Name: ExtractByRectangle_Ex_02.py
# Description: 
# 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"
inRectangle = Extent(477625, 213900, 486400, 224200)

# Execute ExtractByRectangle
rectExtract = ExtractByRectangle(inRaster, inRectangle, "INSIDE")

# Save the output 
rectExtract.save("c:/sapyexamples/output/extrect02")

Environments

Auto Commit, Cell Size, Cell Size Projection Method, Compression, Current Workspace, Extent, Geographic Transformations, Mask, Output CONFIG Keyword, Output Coordinate System, Scratch Workspace, Snap Raster, Tile Size

Licensing information

• Basic: Requires Spatial Analyst
• Standard: Requires Spatial Analyst
• Advanced: Requires Spatial Analyst