summary.param: Inspect a parameter ('param')

In adokter/birdRad: Biological Analysis and Visualization of Weather Radar Data

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:

• DBZH, DBZ: (Logged) reflectivity factor in dBZ.

• TH, T: (Logged) uncorrected reflectivity factor in dBZ.

• VRADH, VRAD: Radial velocity in m/s. Radial velocities towards the radar are negative, while radial velocities away from the radar are positive.

• RHOHV: Correlation coefficient (unitless). Correlation between the vertically and horizontally polarized reflectivity factor.

• PHIDP: Differential phase in degrees.

• ZDR: (Logged) differential reflectivity in dB.

Value

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

See Also

• get_param()

Examples

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

# Check if it is an object of class param
is.param(param)

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

adokter/birdRad documentation built on Nov. 5, 2024, 10:27 p.m.