getBarcodesInPolygon: Obtain barcodes in polygon
In theMILOlab/SPATA2: A Toolbox for Spatial Expression Analysis

getBarcodesInPolygon

R Documentation

Obtain barcodes in polygon

Extracts barcodes of barcode-spots that fall in a given polygon. Works closely with sp::point.in.polygon().

getBarcodesInPolygon(object, polygon_df, strictly = TRUE)

getBarcodesInPolygonList(object, polygon_list, strictly = TRUE)

`object`	An object of class `SPATA2` or, in case of S4 generics, objects of classes for which a method has been defined.
`polygon_df`	A data.frame that contains the vertices of the polygon in form of two variables: x and y. Must be scaled to the dimensions of the currently active image.
`strictly`	Logical value. If `TRUE`, only barcode spots that are strictly interior to the polygon are returned. If `FALSE`, barcodes that are on the relative interior the polygon border or that are vertices themselves are returned, too.
`polygon_list`	A named list of data.frames with the numeric variables x and y. Observations correspond to the vertices of the polygons that confine spatial areas. Must contain a slot named outer which sets the outer border of the spatial area. Can contain multiple slots named inner (suffixed with numbers) that correspond to inner polygons - holes within the annotation. Like inner1, inner2.