Overlay Spatial Objects Over One Another

Create an overlay of some query spatial object (x) against some target object (y). Basically, find all components of a query that fall within the bounds of a target spatial region

Overlay(x, y, invert = FALSE, ...)

# S4 method for Centroids,SpatialPolygons
Overlay(x, y, invert = FALSE, ...)

# S4 method for Segmentation,SpatialPolygons
Overlay(x, y, invert = FALSE, ...)

# S4 method for Molecules,SpatialPolygons
Overlay(x, y, invert = FALSE, ...)

# S4 method for FOV,Spatial
Overlay(x, y, invert = FALSE, ...)

# S4 method for FOV,SpatialPolygons
Overlay(x, y, invert = FALSE, ...)

# S4 method for FOV,FOV
Overlay(x, y, invert = FALSE, ...)

Arguments

x

Query Spatial object

y

Target Spatial object

invert

Invert the overlay and return only the components of x that fall outside the bounds of y

...

Ignored

Value

x with only the components that fall within the bounds of y

Note

This function requires the sf package to be installed