attribute_table: Extract a volume coverage pattern table with all attributes

View source: R/attribute_table.R

attribute_tableR Documentation

Extract a volume coverage pattern table with all attributes

Description

Extract a volume coverage pattern table with all attributes

Usage

attribute_table(
  x,
  select = c("how.lowprf", "how.midprf", "how.highprf", "where.elangle", "where.nbins",
    "where.nrays", "where.rscale", "how.NI"),
  ...
)

Arguments

x

Either a pvol or scan for which the table should be created.

select

A character vector which the column names that should be returned when NULL all attributes are to be returned

...

Currently not used

This function tabulates the attributes of one scan or all scans of a pvol. Attributes that have a length longer then one are presented as a list column. By default the function returns a limited set of columns to keep the output clear. It is important to note that attributes of the full polar volume can contain additional information on processing that is not included in the resulting table. This function only tabulates attributes of the scans.

Value

A data.frame with the attributes of the scan(s)

Examples

data(example_scan)
attribute_table(example_scan)

pvolfile <- system.file("extdata", "volume.h5", package = "bioRad")
example_pvol <- read_pvolfile(pvolfile)
attribute_table(example_pvol)

bioRad documentation built on Oct. 20, 2023, 5:06 p.m.