Extract by Points (Spatial Analyst Tools)

Summary

Extracts the cells of a raster based on a set of coordinate points.

Legacy:

This tool is deprecated and will be removed in a future release.

The Extract by Mask tool provides enhanced functionality or performance.

Illustration

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) value, all bands will be used.

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

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.
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.

Label	Explanation	Data type
Input raster	The input raster from which cells will be extracted.	Raster Layer
Input points	The points where values will be extracted from the raster. The points are specified as x,y coordinate pairs in the same map units as the input raster.	Point
Extraction area (Optional)	Identifies whether to extract cells based on the specified point locations (inside) or outside the point locations (outside) . Inside—The cell in which the selected point falls will be written to the output raster. All cells outside the box will receive NoData on the output raster. Outside—The cells outside the input points should be selected and written to the output raster.	String

Label

Explanation

Data type

Input raster

The input raster from which cells will be extracted.

Raster Layer

Input points

The points where values will be extracted from the raster.

The points are specified as x,y coordinate pairs in the same map units as the input raster.

Point

Extraction area

(Optional)

Identifies whether to extract cells based on the specified point locations (inside) or outside the point locations (outside) .

Inside—The cell in which the selected point falls will be written to the output raster. All cells outside the box will receive NoData on the output raster.
Outside—The cells outside the input points should be selected and written to 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

ExtractByPoints(in_raster, points, {extraction_area})

Name Explanation Data type

Name	Explanation	Data type
in_raster	The input raster from which cells will be extracted.	Raster Layer
points [point,...]	A Python list of `Point` class objects denote the locations where values will be extracted from the raster. The point objects are specified in a list of x,y coordinate pairs in the same map units as the input raster. The form of the object is: `[point(x1,y1), point(x2,y2),...]`	Point
extraction_area (Optional)	Identifies whether to extract cells based on the specified point locations (inside) or outside the point locations (outside) . `INSIDE`—The cell in which the selected point falls will be written to the output raster. All cells outside the box will receive NoData on the output raster. `OUTSIDE`—The cells outside the input points should be selected and written to the output raster.	String

in_raster

The input raster from which cells will be extracted.

Raster Layer

points [point,...]

A Python list of Point class objects denote the locations where values will be extracted from the raster.

The point objects are specified in a list of x,y coordinate pairs in the same map units as the input raster.

The form of the object is:

[point(x1,y1), point(x2,y2),...]

Point

extraction_area

(Optional)

Identifies whether to extract cells based on the specified point locations (inside) or outside the point locations (outside) .

INSIDE—The cell in which the selected point falls will be written to the output raster. All cells outside the box will receive NoData on the output raster.
OUTSIDE—The cells outside the input points should be selected and written to 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

ExtractByPoints example 1 (Python window)

This example extracts cells from a raster based on the specified point coordinates.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
pointList = [arcpy.Point(743050, 4321275), arcpy.Point(743100, 4321200),
             arcpy.Point(734500,4322000)]
outPointExtract = ExtractByPoints("soil", pointList,"INSIDE")
outPointExtract.save("c:/sapyexamples/output/pntextract")

ExtractByPoints example 2 (stand-alone script)

This example extracts cells from a raster based on the specified point coordinates.

# Name: ExtractByPoints_Ex_02.py
# Description: Extracts the cells of a raster based on a set of points.
# 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 = "soil"
pointList = [arcpy.Point(743050, 4321275),
             arcpy.Point(743100, 4321200),
             arcpy.Point(743500, 4322000),
             arcpy.Point(742900, 4321800)]

# Run ExtractByPoints
outPointExtract = ExtractByPoints("soil", pointList,"INSIDE")

# Save the output
outPointExtract.save("c:/sapyexamples/output/pntext")

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

Extract by Points (Spatial Analyst Tools)

Summary

Legacy:

Illustration

Usage

Parameters

Return value

Environments

Licensing information

Related topics