bioRad (version 0.5.1)

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

Description

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

Usage

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

Arguments

object

Object of class param.

...

Additional arguments affecting the summary produced.

x

Object of class param.

Value

for is.scan: TRUE if its argument is of class "param"

Details

An object of class scan is a simple matrix, with the following specific attributes:

radar

character string with the radar identifier

datetime

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

lat

latitude of the radar [decimal degrees]

lon

longitude of the radar [decimal degrees]

height

height of the radar antenna [meters above sea level]

get_elevation_angles

radar beam elevation [degrees]

param

string with the name of the polar scan parameter

Scan parameters are named according to the OPERA data information model (ODIM), see Table 16 in the ODIM specification. Commonly available parameters are:

"DBZH", "DBZ"

(Logged) reflectivity factor [dBZ]

"VRADH", "VRAD"

Radial velocity [m/s]. Radial velocities towards the radar are negative, while radial velocities away from the radar are positive

"RHOHV"

Correlation coefficient [unitless]. Correlation between vertically polarized and horizontally polarized reflectivity factor

"PHIDP"

Differential phase [degrees]

"ZDR"

(Logged) differential reflectivity [dB]

Examples

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

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

# verify this is an object of class param:
is.param(param)

# print summary info for this scan parameter:
param
# }