get_scan: Get a scan ('scan') from a polar volume ('pvol')

View source: R/get_scan.R

get_scanR Documentation

Get a scan (scan) from a polar volume (pvol)

Description

Returns the scan (scan) from a polar volume (pvol) with elevation angle closest to elev.

Usage

get_scan(x, elev, all = FALSE)

Arguments

x

A pvol object.

elev

Numeric. Elevation angle in degrees.

all

Logical. Return the first scan in the pvol object closest to the requested elevation (FALSE), or a list with all scans equally close to the requested elevation (TRUE).

Details

In cases where elev is exactly in between two scan elevation angles, the lower elevation angle scan is returned.

Value

A scan object when all equals FALSE (default), or a list of scan objects if all equals TRUE

See Also

  • summary.scan()

  • get_elevation_angles()

Examples

# Locate and read the polar volume example file
pvolfile <- system.file("extdata", "volume.h5", package = "bioRad")
pvol <- read_pvolfile(pvolfile)

# Get elevation angles
get_elevation_angles(pvol)

# Extract the scan closest to 3 degrees elevation (2.5 degree scan)
scan <- get_scan(pvol, 3)

# Get summary info
scan

# Extract all scans closest to 3 degrees elevation (2.5 degree scan)
# Always returns a list with scan object(s), containing multiple scans
# if the pvol contains multiple scans at the same closest elevation.
scan_list <- get_scan(pvol, 3)
scan_list

bioRad documentation built on Aug. 31, 2022, 1:05 a.m.