summary.pvol: Inspect a polar volume ('pvol')

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

Inspect a polar volume (pvol)

Description

R base functions for inspecting a polar volume (pvol) object.

Usage

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

is.pvol(x)

## S3 method for class 'pvol'
dim(x)

Arguments

object	A pvol object.
...	Additional arguments affecting the summary produced.
x	A pvol object.

Details

A polar volume consists of a number of scans (or sweeps) made by the radar at different elevation angles. A polar volume (pvol) object is a list containing:

• radar: Radar identifier.

• datetime: Nominal time of the volume in UTC.

• scans: List of scans (scan) at different elevation angles.

• attributes: List of the volume's what, where and how attributes.

• geo: List of the volume's geographic properties:

  • lat: Latitude of the radar in decimal degrees.

  • lon: Longitude of the radar in decimal degrees.

  • height: Height of the radar antenna in meters above sea level.

Value

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

For dim.pvol(): number of scans (scan) in a polar volume (pvol).

See Also

• read_pvolfile()

• get_elevation_angles()

• get_scan()

Examples

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

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

# Get summary info
pvol # Same as summary(pvol) or print(pvol)

# Get dimensions
dim(pvol)

# Get summary info for the scans in the polar volume
pvol$scans

adokter/birdRad documentation built on Feb. 1, 2024, 3:40 p.m.