Skip to contents

Legend of a mask

Usage

sg_roi_mask_legend(mask, call = rlang::caller_env())

Arguments

mask

An sg_roi_mask.

call

The calling environment, for error reporting.

Value

The mask's legend tibble::tibble (value, label, layer, roi_id, n_px, colour).

Examples

lyr <- sg_roi_layer_add(sg_roi_layer("tissue"),
                        sg_roi_rect(2, 2, 8, 8, label = "tissue"))
proj <- sg_roi_project(sg_roi_frame(c(20, 20)), lyr)
sg_roi_mask_legend(sg_roi_mask(proj, "labelled"))
#> # A tibble: 1 × 6
#>   value label  layer  roi_id         n_px colour 
#>   <int> <chr>  <chr>  <chr>         <int> <chr>  
#> 1     1 tissue tissue roi_000000029    36 #999999