acplot3d.event_default: Generate a series of 3-D echograms with the function...

View source: R/acplot3d.event_default.R

acplot3d.event_defaultR Documentation

Generate a series of 3-D echograms with the function cplot3d.event(), which are save as png files and can be animated.

Description

Generate a series of 3-D echograms with the function cplot3d.event(), which are save as png files and can be animated.

Usage

acplot3d.event_default(
  event,
  t = NULL,
  range = list(pszx = -80:-10),
  size = "SU90",
  breaks = seq(-86, -40, 2),
  white = 5,
  acca = 5e-04,
  info = "every1_cs_v",
  bgns = FALSE,
  pdns = FALSE,
  hins = FALSE,
  hins_add = 50,
  cores = 1
)

Arguments

event

is the identifier of the event, either given as the number of the event, a string contained in the name of the event, or the path of the event directory.

beams

optional list of beam configuration data in the tSD format.

type

the type of conversion, either "Sv" or "TS".

linear

logical: if TRUE (default) return the linear values (volume backscattering coefficient), if FALSE return dB values (mean volume backscattering).

use

string vector naming the conversions to include. "conv" applies the power to Sv or TS conversion and "tvg" applies the time varied gain (range compensation).

inv

logica: if TRUE do the inverse conversion from Sv or TS to power.

cali

a list of calibration data as returned from readcalfile(). Must contain either 'gain' or 'sacr' or both.

Rlist

StoX R list.

Value

A list of relevant data from the plot.

Examples

## Not run: 
acplot3d.event_default(t=1:10) # Unfinished example
## End(Not run)


arnejohannesholmin/cpplot3d documentation built on April 14, 2024, 11:36 p.m.