Skip to contents

Snap ROI vertices to a grid

Usage

sg_roi_snap(roi, grid = 1, call = rlang::caller_env())

Arguments

roi

An sg_roi.

grid

Positive numeric grid spacing in pixels. Default 1.

call

The calling environment, for error reporting.

Value

An sg_roi with vertices rounded to the nearest grid multiple.

Examples

sg_roi_snap(sg_roi_point(3.4, 5.6, label = "a"), grid = 1)
#> <sg_roi> a (POINT)
#> id: "roi_000000052"  |  level: 0  |  source: manual
#> bbox: [3, 6] - [3, 6]