Bottom Detection

Source: R/EVBottomDetection.R

This function runs a bottom detection on an echogram Bottom algorithms and settings are explained in the [Echoview Help File]('https://support.echoview.com/WebHelp/Reference/Algorithms/Line_picking_algorithm.htm')

EVBottomDetection(EVFile, EVVar, LineName = "Bottom", algorithm = NULL,
  StartDepth = NULL, StopDepth = NULL, MinSv = NULL,
  UseBackstep = NULL, DiscriminationLevel = NULL,
  BackstepRange = NULL, PeakThreshold = NULL, MaxDropouts = NULL,
  WindowRadius = NULL, MinPeakAssymmetry = NULL,
  replaceOldBottom = TRUE, SpanGaps = TRUE)

Arguments

EVFile

An Echoview file COM object
EVVar

An Echoview Variable, accepts inputs as Character, list or Variable object (COMIDispatch)
LineName

Character of the output name for the detected Line
algorithm

numeric [0 - 2] Defines which bottom detection algorithm should be used: 0 for Delta Sv, 1 for Maximum Sv, 2 for Best bottom Candidate
StartDepth

numeric [m] Minimum bottom detection depth
StopDepth

numeric [m] maximum bottom detection detpth
MinSv

numeric [dB] minimum detection Sv
UseBackstep

Boolean [True or False]
DiscriminationLevel

numeric [dB] Minimum discrimination threshold
BackstepRange

numeric [m] Backstep range
PeakThreshold

numeric [dB] Threshold for peak detection
MinPeakAssymmetry

numeric
replaceOldBottom

Boolean (TRUE or FALSE) If TRUE and a line with the same name as LineName already exists, the old line will be overwritten with the new one
SpanGaps

Boolean (TRUE or FALSE) Decides wheteher span gaps is activated or notm default=TRUE
MaxDropOuts

numeric [samples] Maximum number of dropout samples before bottom detection fails
windowRadius

numeric [samples] Search window size

References

http://support.echoview.com/WebHelp/Echoview.htm/

Examples

#To be added - Needs Example data
#Starting Echoview
echoview = StartEchoview()
#> 2018-11-01 10:54:27: Opening Echoview
#> Warning: Couldn't get clsid from the string
#> Error: Invalid class string
#Create a new EV File
EVFile <- EVCreateNew(EVAppObj=echoview, dataFiles = "rawfile.raw")$EVFile
#> 2018-11-01 10:54:27 : Creating new EV file
#> Error in EVNewFile(EVAppObj = EVAppObj, templateFn = templateFn): object 'echoview' not found
Varname <- "Fileset 1: Sv pulse compressed wideband pings T1"
bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom")
#> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found
# Change the algorithm to Best bottom candidate
bottom <- EVBottomDetection(EVFile, EVVar=Varname, LineName="Bottom",algorithm=2)
#> Error in EVAcoVarNameFinder(EVFile, acoVarName = EVVar): object 'EVFile' not found