get_quantity: Get a quantity from a vertical profile ('vp') or time series...

View source: R/get_quantity.R

get_quantityR Documentation

Get a quantity from a vertical profile (vp) or time series of vertical profiles (vpts)

Description

Returns values for the selected quantity from a vertical profile (vp), list, or time series of vertical profiles (vpts). Values are organized per height bin. Values for eta are set to 0, dbz to -Inf and ff, u, v, w, dd to NaN when the sd_vvp for that height bin is below the sd_vvp_threshold().

Usage

get_quantity(x, quantity)

## S3 method for class 'vp'
get_quantity(x, quantity = "dens")

## S3 method for class 'list'
get_quantity(x, quantity = "dens")

## S3 method for class 'vpts'
get_quantity(x, quantity = "dens")

Arguments

x

A vp, list of vp or vpts object.

quantity

Character. A (case sensitive) profile quantity, one of:

  • height: Height bin (lower bound) in m above sea level.

  • u: Ground speed component west to east in m/s.

  • v: Ground speed component south to north in m/s.

  • w: Vertical speed (unreliable!) in m/s.

  • ff: Horizontal speed in m/s.

  • dd: Direction in degrees clockwise from north.

  • sd_vvp: VVP radial velocity standard deviation in m/s.

  • gap: Angular data gap detected in T/F.

  • dbz: Animal reflectivity factor in dBZ.

  • eta: Animal reflectivity in cm^2/km^3.

  • dens: Animal density in animals/km^3.

  • DBZH: Total reflectivity factor (bio + meteo scattering) in dBZ.

  • n: Number of data points used for the ground speed estimates (quantities u, v, w, ff, dd).

  • n_all: Number of data points used for the radial velocity standard deviation estimate (quantity sd_vvp).

  • n_dbz: Number of data points used for reflectivity-based estimates (quantities dbz, eta, dens).

  • n_dbz_all: Number of data points used for the total reflectivity estimate (quantity DBZH).

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

Value

For a vp object: a named (height bin) vector with values for the selected quantity.

For a list object: a list of named (height bin) vectors with values for the selected quantity.

For a vpts object: a (height bin * datetime) matrix with values for the selected quantity.

See Also

  • summary.vp()

  • sd_vvp_threshold()<- for setting the sd_vvp threshold of an object.

Examples

# Extract the animal density (dens) quantity from a vp object
get_quantity(example_vp, "dens")

# Extract the horizontal ground speed (ff) quantity from a vpts object and show the
# first two datetimes
get_quantity(example_vpts, "ff")[,1:2]

bioRad documentation built on Aug. 31, 2022, 1:05 a.m.