echoIBM_rexp_defaults: Creates a list of default settings for noise generation...

View source: R/echoIBM_rexp_defaults.R

echoIBM_rexp_defaultsR Documentation

Creates a list of default settings for noise generation methods used in echoIBM, specifically the Multiple Sines - method ("ms"), the rearrangement method of uniform independent variables resulting in correlated and autocorrelated beams, and the simple independent exponential distribution (in which case only 'ssed' is defaulted).

Description

Creates a list of default settings for noise generation methods used in echoIBM, specifically the Multiple Sines - method ("ms"), the rearrangement method of uniform independent variables resulting in correlated and autocorrelated beams, and the simple independent exponential distribution (in which case only 'ssed' is defaulted).

Usage

echoIBM_rexp_defaults(
  noisetypes = "ms",
  indt = NULL,
  data = list(),
  parlist = list()
)

Arguments

noisetypes

is a vector of character strings of length 2, specifying which types of noise to apply to the data:

data

is a list of the required beam configuration information, including length 'lenb' of the beams, number 'numb' of beams and the frequency 'freq' of the beams, as well as the sonar/echosounder type 'esnm'.

parlist

is a list of input parameters to the function echoIBM.add.noise(), which generates noise and randomness. See echoIBM.add.noise() for explaination of the possible variables.


arnejohannesholmin/echoIBM documentation built on April 14, 2024, 11:37 p.m.