Clip an ROI to image bounds
Usage
sg_roi_clamp(roi, dims, call = rlang::caller_env())Arguments
- roi
An sg_roi.
- dims
Integer
c(width, height)bounds in pixels.- call
The calling environment, for error reporting.
Value
An sg_roi clipped to [0, width] x [0, height]. Warns if the
clip empties the geometry.
See also
Other geometry:
sg_roi_buffer(),
sg_roi_check_containment(),
sg_roi_check_geometry(),
sg_roi_contains(),
sg_roi_distance(),
sg_roi_fix_geometry(),
sg_roi_flip_y(),
sg_roi_overlaps(),
sg_roi_rescale(),
sg_roi_ring(),
sg_roi_rois_overlap(),
sg_roi_setops,
sg_roi_simplify(),
sg_roi_snap(),
sg_roi_transform()
Examples
sg_roi_clamp(sg_roi_rect(-5, -5, 20, 20, label = "a"), dims = c(10, 10))
#> <sg_roi> a (POLYGON)
#> id: "roi_000000012" | level: 0 | source: manual
#> bbox: [0, 0] - [10, 10]