get.hins.event_small: Estimates high intensity noise in an underwater acoustic...

View source: R/get.hins.event_small.R

get.hins.event_smallR Documentation

Estimates high intensity noise in an underwater acoustic system, by identifying high intensity one dimensional spikes.

Description

Estimates high intensity noise in an underwater acoustic system, by identifying high intensity one dimensional spikes.

Usage

get.hins.event_small(
  con = NULL,
  event = 1,
  cruise = 2009116,
  esnm = "MS70",
  t = 1:10,
  k = 5,
  q = c(1000, 100),
  beta_school = 2e-04,
  ind = list(-(1:100), NULL),
  max.memory = 2e+09,
  ...
)

Arguments

con

is the connection object or a character string naming the output file.

event

is the identifier of the event. Given either as the number of the event, a string contained in the name of the event, or the path of the event directory. More than one event may be given, in a vector.

cruise

is the identifier of the cruise. Given either as the specification used by 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. See sonR_implemented() for the implemented systems. May be given in 'data', and in lower case.

t

is the identifier of the time points. Given either as a vector of integers between 1 and the number of pings in the event, or a vector of time points given as strings "yyyymmddHHMMSS.FFF" or "HHMMSS.FFF" from which the range of the time points are extracted. If t=="all", all files are read and if t=="none" no action is done. If more than one event is given, 't_bgns' must be given as a list of vectors.

k

is a numeric giving the width of the medians across pings, used in runmed() inside get.hins.event_small().

q

is either a single numeric, or a vector of length 2, givin the start and end point in the linear function along beams defining the threshold times the median filtered values in each direction above which data are classified as high intensity noise.

beta_school

is a single numeric representing a typical high school value. Only values above 'beta_school' can be classified as high intensity noise. 'beta_school' assures that spikes due to for example fish in very silent regions of the data are not classified as high intensity noise.

ind

is a list of indexes, as given to subset_TSD(), used to select the subset over which the estimation of high intensity noise is done. Defaulted to exclude the first 100 voxels along each beam.

max.memory

puts a restiction on the mempry occupied by the function, prompting a call to the user to approve is exceeded.

...

variables used in write.TSD() (such as 'ow' for overwriting existing files).


arnejohannesholmin/sonR documentation built on April 14, 2024, 11:39 p.m.