getGridVisiumHD: Obtain grid information

getGridVisiumHDR Documentation

Obtain grid information

Description

Generates a data.frame of grid elements for visualizing a grid overlay on VisiumHD spatial data.

Usage

getGridVisiumHD(object, res, img_name = activeImage(object))

Arguments

object

An object of class SPATA2 or, in case of S4 generics, objects of classes for which a method has been defined.

res

A distance value specifying the desired resolution for the grid in micrometers (e.g., "32um"). The resolution must be greater than or equal to the current resolution and divisible by the current resolution.

img_name

Character value. The name of the image of interest. If NULL, the active image is chosen by default. Either way, must be one of getImageNames().

Value

A data frame with the following columns:

  • idx: A character vector representing the identifier for each segment, typically indicating the row or column number (e.g., "row_9").

  • x: A numeric vector representing the x-coordinate of the starting point of the segment.

  • y: A numeric vector representing the y-coordinate of the starting point of the segment.

  • xend: A numeric vector representing the x-coordinate of the ending point of the segment.

  • yend: A numeric vector representing the y-coordinate of the ending point of the segment.

  • just: A character vector indicating the orientation of the segment (e.g., "horizontal").


theMILOlab/SPATA2 documentation built on Feb. 8, 2025, 11:41 p.m.