bscat: Backscattering model

View source: R/bscat.R

bscatR Documentation

Backscattering model

Description

Run the DWBA model for a given set of parameters. Visit the vignette for more details (../doc/DwbaCommand.html)

Usage

bscat(
  para,
  misc,
  app = FALSE,
  nang = NULL,
  nl = NULL,
  simOut = TRUE,
  plotOut = TRUE
)

Arguments

para

[list] A list containing all the model parameters (../doc/parameters.html)

misc

[list] A list containing the soundspeed (cw) of the surrounding fluid (to compute cw visit c_Coppens1981 or c_Leroy08 or c_Mackenzie1981)

app

= FALSE [boolean] function call from shiny interface or command line

nang

[integer] Number of angular ismulations, this will overwrite increment

nl

[integer] Number of Length simulations, will overwrite increment informaiton

simOut

= TRUE [boolean] If TRUE ysim (results for the simulated orientations) and ysimL (results for the simulated lengths based on the results of the mean simulated angle) as well as ang (simulated orientation angles) and L (simulated lengths) are added to the function output (average is kept as well), which contains all simulated data, if FALSE, only the averaged value is kept

plotOut

= TRUE [boolean] If results plot should be produced or not

Value

list with all parameters for DWBA

Author(s)

Sven Gastauer

Examples

#Get filename of the parameters file
fname <- paste0(system.file(package = "ZooScatR"),"/extdata/configs/config_0.dat")
#Read in teh parameter
para = read_para(fname)
#Create list with soundspeed info
misc <- list()
misc$cw <- 1500
#Change some of the settings
#Set starting frequency over which to run the model
para$simu$var0 <- 38
#Set end frequency over which to run te model
para$simu$var1 <- 300
# run DWBA based on the settings defined in the parameters file
res <- bscat(para=para, misc=misc, app=FALSE)
#plot the results of the model
res$rplot


AustralianAntarcticDivision/ZooScatR documentation built on Aug. 13, 2022, 1:21 a.m.