bioRad (version 0.5.1)

summary.scan: Class scan: a scan of a polar volume

Description

Class scan for a scan of a polar volume, and its associated R base functions.

Usage

# S3 method for scan
summary(object, ...)
is.scan(x)
# S3 method for scan
dim(x)

Arguments

object

Object of class scan

...

Additional arguments affecting the summary produced.

x

Object of class scan

Value

For is.scan: TRUE if its argument is of class scan.

For dim.scan: dimensions of the scan.

Details

A object of class scan is a list containing:

radar

character string with the radar identifier

datetime

nominal time of the volume to which this scan belongs [UTC]

params

a list with scan parameters

attributes

list with the scan's \what, \where and \how attributes

geo

geographic data, a list with:

lat

latitude of the radar [decimal degrees]

lon

longitude of the radar [decimal degrees]

height

height of the radar antenna [meters above sea level]

elangle

radar beam elevation [degrees]

rscale

range bin size [m]

ascale

azimuth bin size [deg]

The geo element of a scan object is a copy of the geo element of its parent polar volume of class pvol.

Examples

# NOT RUN {
# load example scan object
data(example_scan)

# verify this object is of class scan:
is.scan(example_scan)

# print the scan parameters contained in the scan:
example_scan$params

# extract the VRADH scan parameter:
param <- get_param(example_scan, "VRADH")

# print summary info for this scan parameter:
param
is.scan("this is not a polar scan but a string") # > FALSE
# }