EVNewLineRelativeRegion: Creates a new line relative region in the current variable

In AustralianAntarcticDivision/EchoviewR: Control of Echoview via COM

Creates a new line relative region in the current variable

Description

This function creates a new line relative region in the current variable using COM scripting. The upper and lower depths are specified using Echoview line objects (these must already exist). Left and right bounds are optionally specified using ping number.

Usage

EVNewLineRelativeRegion(
  EVFile,
  varName,
  regionName,
  line1,
  line2,
  firstPing = NA,
  lastPing = NA
)

Arguments

EVFile	An Echoview file COM object
varName	a string containing the name of the acoustic variable to create the region in
regionName	a string containing the name to assign to the new region
line1	a string containing the name of the upper line limit
line2	a string containing the name of the lower line limit
firstPing	an optional integer for the ping to begin the region at
lastPing	an optional integer for the ping to end the region at

Value

returns the EV Region object

References

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

See Also

EVOpenFile

Examples

## Not run: 
EVAppObj <- COMCreate('EchoviewCom.EvApplication')
EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile

#create a region between pings 1 - 100 and depths 20-250m
newRegion <- EVNewLineRelativeRegion(EVFile, 
"38 seabed and surface excluded", "test", 
"Fixed depth 6 m", "Fixed depth 250 m", 1, 100)

#create an unbounded region between depths 250-750m
newRegion <- EVNewLineRelativeRegion(EVFile, "38 seabed and surface excluded", "test", "Fixed depth 6 m", "Fixed depth 250 m")

## End(Not run)

AustralianAntarcticDivision/EchoviewR documentation built on May 14, 2024, 10:32 a.m.