get.pdns_phase.event: Estimates the phase of the periodic noise of the MS70 sonar....

In arnejohannesholmin/sonR: Library for reading, processing and converting sonar data to the TSD format

Estimates the phase of the periodic noise of the MS70 sonar. If the variables 'badb', 'pns1', 'pns2', 'harm' and 'bgns' are not present in the input list 'data', an attempt is made to read them from the directory holding the noise estimate for the given event. Only used in echoIBM.vbsc2p.event().

Description

Estimates the phase of the periodic noise of the MS70 sonar. If the variables 'badb', 'pns1', 'pns2', 'harm' and 'bgns' are not present in the input list 'data', an attempt is made to read them from the directory holding the noise estimate for the given event. Only used in echoIBM.vbsc2p.event().

Usage

get.pdns_phase.event(
  event = 1,
  cruise = 2009116,
  esnm = "MS70",
  t = 1:100,
  noise = list(),
  nsind = 0.75,
  dir.data = NULL,
  pdns_scale = 1e-14,
  TVG = TRUE
)

Arguments

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	The name of the acoustic system for ehich to estimate the phase of the periodic noise.
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.
noise	is a list of the periodic noise parameters for the magnitude (pns1), kurtosis (pns2), harmonics (harm) and identifyers for the periodic beams (badb), and the background noise (bgns) for use in the estimation of periodic noise. If not given, these are attempted to be read from the noise files of the cruise.
nsind	is a vector of indexes along the beams, as input to ind.expand(), used to select the subset over which the estimation of the phase of the periodic noise is done. If given as a single numeric, the outermost 'nsind' voxels are used in each beam.
dir.data	is the path to the directory in which the projects are stored, defaulted by the variable Acoustics_datasets_directory().
pdns_scale	is used to scale the noise in order to allow the optimization to work.
TVG	is FALSE if TVG compensation is to be removed from the data.

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