Learn R Programming

bioRad (version 0.4.0)

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

Description

Make a plan position indicator (ppi)

Usage

project_as_ppi(x, grid_size = 500, range_max = 50000,
  project = FALSE, ylim = NULL, xlim = NULL)

# S3 method for param project_as_ppi(x, grid_size = 500, range_max = 50000, project = FALSE, ylim = NULL, xlim = NULL)

# S3 method for scan project_as_ppi(x, grid_size = 500, range_max = 50000, project = FALSE, ylim = NULL, xlim = NULL)

Arguments

x

An object of class param or scan.

grid_size

Cartesian grid size in m.

range_max

Maximum range in m.

project

Whether to vertically project onto earth's surface.

ylim

The range of latitudes to include.

xlim

The range of longitudes to include.

...

Arguments passed to methods.

Value

An object of class 'ppi'.

Methods (by class)

  • param: Project as ppi for a single scan parameter.

  • scan: Project multiple ppi's for all scan parameters in a scan

Details

The returned PPI is in Azimuthal Equidistant Projection.

Examples

Run this code
# NOT RUN {
# load a polar scan example object
data(example_scan)
example_scan
# make PPIs for all scan parameters in the scan:
ppi <- project_as_ppi(example_scan)
# print summary info for the ppi:
ppi
# copy the first scan parameter of the first scan in the volume to a new
# object 'param':
param <- example_scan$params[[1]]
# make a ppi for the new 'param' object:
ppi <- project_as_ppi(param)
# print summary info for this ppi:
ppi
# }

Run the code above in your browser using DataLab