Query the ROIs of a project

Return a tidy table of ROIs, optionally filtered by layer and/or label.

Usage

at_rois(project, layer = NULL, label = NULL, call = rlang::caller_env())

Arguments

project

An annot_project.

layer

Optional single layer name to filter to.

label

Optional character vector of labels to filter to.

call

The calling environment, for error reporting.

Value

A tibble::tibble with one row per ROI and, in this exact order, the columns:

roi_id

Unique identifier (character).

layer

Layer name (character).

label

Class label (character).

geom_type

Geometry type, e.g. "POLYGON" (character).

level

Coordinate pyramid level, always 0 (integer).

source_level

Stored ROI reference level (integer provenance).

area_px

Area in level-0 pixels (double); NA for points/lines.

centroid_x,centroid_y

Centroid at level 0 (double).

n_vertices

Vertex count (integer).

created,modified

Timestamps (POSIXct).

author

Author (character).

source

Provenance source (character).

geometry

The sf geometry column (sfc), at level 0.

Returns a 0-row tibble with these columns if no ROIs match.

Details

Coordinates in the geometry column, together with area_px and the centroid, are expressed at pyramid level 0. The level column is 0; source_level records the stored level at which each ROI was defined.

Older tables used level for the stored reference level despite returning level-0 geometry. Consumers needing that provenance must now use source_level. The stored ROI geometry, level, and identifier are unchanged.

See also

at_layers(), at_mask()

Other projects: at_add_layer(), at_add_roi(), at_example_project(), at_layers(), at_project(), at_remove_layer(), at_remove_roi(), at_summary(), at_validate()

Examples

# proj <- at_example_project()
# at_rois(proj)