Skip to contents

Report how an image's pixels are read: whether opening it reads metadata only, whether tiles are read as windows from the file, what the samples mean, and where they come from.

Usage

at_image_capabilities(x)

Arguments

x

An annot_image or annot_project.

Value

A list with metadata_only and window_read (logical; NA when a third-party backend does not declare them), samples ("raw-scalar-v1" for stored values, "display-converted-0-255" for display conversions, "unqualified" when undeclared) and io ("binary", "native", "eager", "memory" or "unknown"), plus an optional lifecycle. An image whose handle holds decoded pixels reports memory access even for a backend that normally reads windows.

Examples

at_image_capabilities(at_example_image("cube"))$window_read
#> [1] TRUE