R: Overlay 'Spatial' Objects Over One Another

Overlay {SeuratObject} | R Documentation

## Overlay `Spatial` Objects Over One Another

### Description

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

### Usage

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

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

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

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

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

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

    ## S4 method for signature '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`

[Package SeuratObject version 4.1.0 Index]