Reading radar data

Functions to read polar volume (pvol) data. Requires a locally running Docker daemon for NEXRAD data.

is.pvolfile()

Check if a local file is a polar volume (pvol)

get_odim_object_type()

Check the ODIM data class of a polar volume file

nexrad_to_odim()

Convert a NEXRAD polar volume file to an ODIM polar volume file

read_pvolfile()

Read a polar volume (pvol) from file

summary(<pvol>) is.pvol()

Class pvol: a polar volume

Inspecting radar scans

Functions to inspect and plot a polar scan (scan) from a polar volume (pvol).

get_elevation_angles()

Get elevation angles of a polar volume (pvol) or scan (scan)

get_scan()

Get a scan (scan) from a polar volume (pvol)

summary(<scan>) is.scan() dim(<scan>)

Class scan: a scan of a polar volume

example_scan

Example object of class scan

plot(<scan>)

Plot a scan (scan) in polar coordinates

get_param()

Get a scan parameter (param) from a scan (scan)

summary(<param>) is.param()

Class param: a parameter of a scan of a polar volume

Manipulating radar scans

Functions to manipulate radar images (scan, param, ppi) and to identify precipitation.

integrate_to_ppi()

Calculate a plan position indicator (ppi) of vertically integrated density adjusted for range effects

calculate_param()

Calculate a new scan parameter

apply_mistnet()

Apply MistNet segmentation to a polar volume

Plotting radar scans

Functions to plot a polar volume (pvol), scan (scan) or parameter (param) on a grid or basemap as a plan position indicator (ppi).

project_as_ppi()

Project a scan (scan) or parameter (param) to a plan position indicator (ppi)

integrate_to_ppi()

Calculate a plan position indicator (ppi) of vertically integrated density adjusted for range effects

scan_to_raster()

convert a polar scan into a raster

scan_to_spatial()

convert a polar scan into a spatial object.

summary(<ppi>) is.ppi() dim(<ppi>)

Class ppi: a plan position indicator

plot(<ppi>)

Plot a plan position indicator (ppi)

map()

Map a plan position indicator (ppi)

download_basemap()

Download a basemap for map(ppi)

composite_ppi()

Create a composite of multiple plan position indicators (ppi)

`[`(<ppi>)

Subset a plan position indicator (ppi)

Creating vertical profiles of biological targets

Functions to process weather radar data (pvol) into vertical profiles (vp) of biological targets. Requires a locally running Docker daemon.

calculate_vp()

Calculate a vertical profile (vp) from a polar volume (pvol)

check_docker()

Check if Docker is running

update_docker()

Update Docker image from Docker hub

nexrad_to_odim()

Convert a NEXRAD polar volume file to an ODIM polar volume file

vol2bird_version()

Check version of the vol2bird algorithm used by bioRad

Reading vertical profile data

Functions to download, read, inspect and plot vertical profile (vp) data.

download_vpfiles()

Download vertical profile (vp) files from the ENRAM data repository

select_vpfiles()

Select vertical profile (vp) files from computer

is.vpfile()

Check if a local file is a vertical profile (vp)

read_vpfiles()

Read a vertical profile (vp) or a list of vertical profiles (vp) from files

read_cajun()

Read a vertical profile (vp) from UMASS Cajun text file

summary(<vp>) is.vp() dim(<vp>)

Class vp: a vertical profile of animals

example_vp

Example object of class vp

plot(<vp>)

Plot a vertical profile (vp)

as.data.frame(<vp>)

Convert a vertical profile (vp) to a Data Frame

Combining vertical profiles into time series

Functions to combine vertical profiles (vp) into time series (vpts) and read, inspect and plot these.

c(<vp>)

Concatenate vertical profiles (vp) into a list of vertical profiles

bind_into_vpts()

Bind vertical profiles (vp) into time series (vpts)

read_vpts()

Read a time series of vertical profiles (vpts) from file

filter_vpts()

Time selection in a time series of vertical profiles ('vpts')

summary(<vpts>) is.vpts() dim(<vpts>)

Class vpts: a time series of vertical profiles

example_vpts

Example object of class vpts

plot(<vpts>)

Plot a time series of vertical profiles (vpts)

regularize_vpts()

Regularize a time series of vertical profiles (vpts) on a regular time grid

as.data.frame(<vpts>)

Convert a time series of vertical profiles (vpts) to a data frame

`[`(<vpts>)

Subset a time series of vertical profiles (vpts)

get_quantity()

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

Integrating vertical profiles

Functions to calculate e.g. the migration traffic rate (MTR) by vertically integrating profiles (vp or vpts) into an integrated profile (vpi).

integrate_profile()

Vertically integrate profiles (vp or vpts) to an integrated profile (vpi)

plot(<vpi>)

Plot an integrated profile (vpi)

Accessing vertical profile metadata

Functions to access metadata of vertical profiles (vp), time series (vpts) or integrated profiles (vpi).

rcs()

Get radar cross section

`rcs<-`()

Set radar cross section

sd_vvp_threshold()

Get threshold of the VVP-retrieved radial velocity standard deviation

`sd_vvp_threshold<-`()

Set threshold of the VVP-retrieved radial velocity standard deviation

check_night()

Check if it is night at a given time and place

Radar beam geometry

Functions relating the radar beam shape to range, distance and height

beam_height()

Calculate radar beam height

beam_width()

Calculate radar beam width

beam_range()

Calculate radar beam range

beam_distance()

Calculate radar beam distance

beam_profile()

Calculate vertical radiation profile

beam_profile_overlap()

Calculate overlap between a vertical profile ('vp') of biological scatterers and the vertical radiation profile emitted by the radar

Other functions

Other useful functions.

dbz_to_eta()

Convert reflectivity factor to reflectivity

eta_to_dbz()

Convert reflectivity to reflectivity factor

nyquist_velocity()

Nyquist velocity for a given pulse repetition frequency (PRF)

sunrise() sunset()

Calculate sunrise or sunset for a time and place