vol2bird: Calculate a vertical profile ('vp') from a polar volume...
In vol2birdR: Vertical Profiles of Biological Signals in Weather Radar Data

vol2bird

R Documentation

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

Description

Calculates a vertical profile of biological scatterers (vp) from a polar volume (pvol) file using the algorithm vol2bird (Dokter et al. 2011 \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1098/rsif.2010.0116")}).

Usage

vol2bird(
  file,
  config,
  vpfile = "",
  pvolfile_out = "",
  verbose = TRUE,
  update_config = FALSE
)

Arguments

`file`	Character (vector). Either a path to a single radar polar volume (`pvol`) file containing multiple scans/sweeps, or multiple paths to scan files containing a single scan/sweep. The file data format should be either 1) ODIM format, which is the implementation of the OPERA data information model in the HDF5 format, 2) NEXRAD format supported by the 'RSL' library or 3) Vaisala IRIS (IRIS RAW) format. IRIS format is not available on CRAN, see vol2birdR development version on Github.
`config`	optional configuration object of class `Rcpp_Vol2BirdConfig`, typically output from vol2bird_config
`vpfile`	Character. File name. When provided with .csv extension, writes a vertical profile time series (vpts) in the standard CSV format. Proivded with another or no exentsion, writes a vertical profile vertical profile file (`vpfile`) in the ODIM HDF5 format to disk.
`pvolfile_out`	Character. File name. When provided, writes a polar volume (`pvol`) file in the ODIM HDF5 format to disk. Useful for converting 'RSL' formats to ODIM, and for adding 'MistNet' segmentation output.
`verbose`	logical. When TRUE print profile output to console.
`update_config`	logical. When TRUE processing options that are determined based on input file characteristics are returned and updated in the object specified by the `config` argument. Do not set to `TRUE` when `vol2bird()` is used in loops like `lapply()` or in parallel processes.

Value

No value returned, creates a file specified by file argument

Examples

# Locate the polar volume example file
pvolfile <- system.file("extdata", "volume.h5", package = "vol2birdR")

# Create a configuration instance:
conf <- vol2bird_config()

# Define output file
output_file <- paste0(tempdir(), "/vp.h5")

# Calculate the profile:
vol2bird(file = pvolfile, config = conf, vpfile = output_file)

vol2birdR documentation built on May 31, 2023, 6 p.m.