echoIBM.sesg2event: Creates a new event from segmentation files. The directory of...

View source: R/echoIBM.sesg2event.R

echoIBM.sesg2eventR Documentation

Creates a new event from segmentation files. The directory of the event must be created in advance, to ensure secure generation of the event.

Description

Creates a new event from segmentation files. The directory of the event must be created in advance, to ensure secure generation of the event.

Usage

echoIBM.sesg2event(
  event,
  pingsdir,
  t = 1,
  filesize = 3e+08,
  type = "scsg",
  segpar = NULL,
  ow = TRUE,
  cruise = 2009116,
  esnm = "MS70",
  dir.data = NULL
)

Arguments

event

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

pingsdir

is the path to the new event.

t

is the time points to process.

filesize

is the maximum size of the files.

type

is one of "sgsc", representing estimated segmentation data, and "sgs0", representing theoretical segmentation data.

segpar

is a list of elements named "bwGp", "lsth"/"rlst", "usth"/"rust", or "sgth"/"sgt0" specifying the parameters of the segmentation data to read.

ow

is TRUE if the user wish to overwrite existing files.

cruise

is either the idenfication number of the cruise, given as specified by the IMR (yyyynnn), or the path to the directory containing the event to be read.

esnm

is the name of the acoustical instrument, given as a four character string. Currently implemented are "EK60", "ME70", "MS70" and "SH80"/"SX80"/"SH90"/"SX90" (may be given in lover case)

dir.data

is the path to the directory in which the projects are stored, defaulted by the variable Acoustics_datasets_directory().


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