summary.ppi {bioRad}R Documentation

Inspect a plan position indicator (ppi)

Description

R base functions for inspecting a plan position indicator (ppi) object.

Usage

## S3 method for class 'ppi'
summary(object, ...)

is.ppi(x)

## S3 method for class 'ppi'
dim(x)

Arguments

object

A ppi object.

...

Additional arguments affecting the summary produced.

x

A ppi object.

Details

A plan position indicator is a projection of radar data onto the earth's surface, generated from a single scan (scan) with project_as_ppi(), a polar volume (pvol) with integrate_to_ppi() or multiple plan position indicators (ppi) with composite_ppi(). A plan position indicator (ppi) object is a list containing:

Value

For is.ppi(): TRUE for an object of class ppi, otherwise FALSE.

For dim.ppi(): number of parameters (param), x and y pixels in a plan position indicator (ppi).

See Also

Examples

# Project the example scan as a ppi
ppi <- project_as_ppi(example_scan)

# Verify that it is an object of class ppi
is.ppi(ppi)

# Get summary info
ppi # Same as summary(ppi) or print(ppi)

# Get dimensions
dim(ppi)

[Package bioRad version 0.5.2 Index]