summary.vp: Class `vp`: a vertical profile of birds

Description

Class vp for a vertical profile of birds, and its associated R base functions.

Usage

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

Arguments

object

An object of class vp.

...

Additional arguments affecting the summary produced.

An object of class vp.

Value

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

For dim.vp: dimensions of the profile data.

Details

An object of class vp contains a vertical profile. A vertical profile contains a collection of quantities, with each quantity having values at different altitude layers above the earth's surface, typically equally spaced altitudinal layers.

Data contained in this class object should be accessed with the get_quantity function. Information stored under attributes (see below) can be accessed directly.

A vp object is a list containing

radar

the radar identifier

datetime

the nominal time of the profile

data

the profile data, a list containing:

HGHT: height above mean sea level [m]. Alt. bin from HGHT to HGHT+interval)
u: speed component west to east [m/s]
v: speed component north to south [m/s]
w: vertical speed (unreliable!) [m/s]
ff: horizontal speed [m/s]
dd: direction [degrees, clockwise from north]
sd_vvp: VVP radial velocity standard deviation [m/s]
gap: Angular data gap detected [T/F]
dbz: Bird reflectivity factor [dBZ]
eta: Bird reflectivity [cm^2/km^3]
dens: Bird density [birds/km^3]
DBZH: Total reflectivity factor (bio+meteo scattering) [dBZ]
n: number of points VVP bird velocity analysis (u,v,w,ff,dd)
n_all: number of points VVP st.dev. estimate (sd_vvp)
n_dbz: number of points bird density estimate (dbz,eta,dens)
n_dbz_all: number of points total reflectivity estimate (DBZH)

attributes

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