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

View source: R/get.pdns_phase.TSD.R

get.pdns_phase.TSDR Documentation

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 MS70 noise estimate for the given 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 MS70 noise estimate for the given event.

Usage

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

Arguments

data

is a list of the following variables ( can be obtained by data=c(read.event(var=c("beams","vbsc","")),read.TSDs(noise.path(),var=c("pns1","pns2","harm","badb","bgns","acfq"))) ):

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.

cruise, event, esnm

Used in noise.path to get the path to the noise data holding the background noise, if missing in the data.

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.