summary.param {bioRad}R Documentation

Inspect a parameter (param)

Description

R base functions for inspecting a parameter (param) object.

Usage

## S3 method for class 'param'
summary(object, ...)

is.param(x)

Arguments

object

A param object.

...

Additional arguments affecting the summary produced.

x

A param object.

Details

A parameter is a quantity/variable measured by the radar during a scan (or sweep). These are organized along radar range (bins) and azimuth (rays). Scan parameters are named according to the OPERA data information model (ODIM), see Table 16 in the ODIM specification.

Commonly available parameters are:

Value

For is.param(): TRUE for an object of class param, otherwise FALSE.

See Also

get_param()

Examples

# Extract the DBZH scan parameter from the example scan
param <- get_param(example_scan, "DBZH")

# Verify that it is an object of class param
is.param(param)

# Get summary info for this parameter
param # Same as summary(param) or print(param)

[Package bioRad version 0.5.2 Index]