Skip to contents

Geometry is in local array pixels. Changes retain image binding and are staged for explicit review. Overlapping cells are rejected.

Usage

sg_canvas_correct(
  mask,
  geometry = NULL,
  action = "add",
  cell_id = NULL,
  expected_revision
)

Arguments

mask

An sg_mask.

geometry

GeoJSON Polygon or MultiPolygon, required for add/edit.

action

One of add, edit, erase.

cell_id

Existing integer label for edit/erase.

expected_revision

Revision shown when the edit began.

Value

A staged sg_mask.

Examples

msk <- new_sg_mask(matrix(0L, 8, 9))
box <- list(type = "Polygon",
            coordinates = list(list(c(1, 1), c(4, 1), c(4, 4), c(1, 4), c(1, 1))))
added <- sg_canvas_correct(msk, box, expected_revision = sg_mask_revision(msk))
sum(added$labels > 0)
#> [1] 9
added$review$status
#> [1] "staged"