bioRad (version 0.5.1)

summary.ppi: Class ppi: a plan position indicator

Description

Class ppi for a plan position indicator, and its associated R base functions.

Usage

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

Arguments

object

Object of class ppi.

...

Additional arguments affecting the summary produced.

x

Object of class ppi.

Value

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

For dim.ppi: dimensions of the ppi.

Details

ppi objects are generated from elevation scans (scan objects) with project_as_ppi or from polar volumes with integrate_to_ppi, producing projections of the radar data onto the earth's surface.

An object of class ppi is a list containing:

data

an object of class SpatialGridDataFrame containing the georeferenced data. Commonly available parameters are:

"DBZH", "DBZ"

(Logged) reflectivity factor [dBZ]

"TH", "T"

(Logged) uncorrected reflectivity factor [dBZ]

"VRADH", "VRAD"

Radial velocity [m/s]. Radial velocities towards the radar are negative, while radial velocities away from the radar are positive

"RHOHV"

Correlation coefficient [unitless]. Correlation between vertically polarized and horizontally polarized reflectivity factor

"PHIDP"

Differential phase [degrees]

"ZDR"

(Logged) differential reflectivity [dB]

geo

geographic data, a list with:

lat

latitude of the radar [decimal degrees]

lon

longitude of the radar [decimal degrees]

height

height of the radar antenna [meters above sea level]

elangle

radar beam elevation [degrees]

rscale

range bin size [m]

ascale

azimuth bin size [deg]

The geo element of a 'scan' object is a copy of the geo element of its parent scan or scan parameter.

Examples

# NOT RUN {
# load example scan object
data(example_scan)

# calculate ppi object
example_ppi <- project_as_ppi(example_scan)

# print summary info:
example_ppi

# verify exampl_ppi is a ppi object:
is.ppi(example_ppi)

# ppi object dimensions:
dim(example_ppi)
# }