EVFishTracking: Detect Fish Tracks

View source: R/EVFishTracking.R

EVFishTrackingR Documentation

Detect Fish Tracks

Description

This function runs fish track detection on an single target echogram Fish track algorithms and settings are explained in the [Echoview Help File]('https://support.echoview.com/WebHelp/Echoview.htm')

Usage

EVFishTracking(
  EVFile,
  EVVar,
  FishTrackRegionClass = "Unclassified regions",
  export = NULL,
  DataDimensions = NULL,
  Alpha.MajorAxis = NULL,
  Alpha.MinorAxis = NULL,
  Alpha.Range = NULL,
  Beta.MajorAxis = NULL,
  Beta.MinorAxis = NULL,
  Beta.Range = NULL,
  ExclusionDistance.MajorAxis = NULL,
  ExclusionDistance.MinorAxis = NULL,
  ExclusionDistance.Range = NULL,
  MissedPingExpansion.MajorAxis = NULL,
  MissedPingExpansion.MinorAxis = NULL,
  MissedPingExpansion.Range = NULL,
  Weights.MajorAxis = NULL,
  Weights.MinorAxis = NULL,
  Weights.Range = NULL,
  Weights.TS = NULL,
  Weights.PingGap = NULL,
  MinimumTargets = NULL,
  MinimumPings = NULL,
  MaximumGap = NULL
)

Arguments

EVFile

An Echoview file COM object

EVVar

An Echoview single target variable as a character string

FishTrackRegionClass

string indicating the region class name for the fish tracks to be assigned

export

full file path as a text string for an export file (i.e. "C:/FishTracking/Exports/FishTracks.csv"). NULL value skips export of fish tracks.

DataDimensions

numeric Determine which algorithim is used for fish tracks. Accepted values are 2 (single or dual beam) or 4 (split beam)

Alpha.MajorAxis

numeric Increases Alpha gain setting of Major Axis

Alpha.MinorAxis

numeric Increases Alpha gain setting of Minor Axis

Alpha.Range

numeric Increases Alpha gain setting of Range

Beta.MajorAxis

numeric Increases Beta gain setting of Major Axis

Beta.MinorAxis

numeric Increases Beta gain setting of Minor Axis

Beta.Range

numeric Increases Beta gain setting of Range

ExclusionDistance.MajorAxis

numeric Increases distance value of major axis in target gate parameters

ExclusionDistance.MinorAxis

numeric Increases distance value of minor axis in target gate parameters

ExclusionDistance.Range

numeric Increases distance value of range in target gate parameters

MissedPingExpansion.MajorAxis

numeric Increases expansion value of major axis in target gate parameters

MissedPingExpansion.MinorAxis

numeric Increases expansion value ofminor axis in target gate parameters

MissedPingExpansion.Range

numeric Increases expansion value of missed pings range in target gate parameters. 0 disables missed ping expansion

Weights.MajorAxis

numeric 1-100 Assigns the weighting of the major axis

Weights.MinorAxis

numeric 1-100 Assigns the weighting of the minor axis

Weights.Range

numeric 1-100 Assigns the weighting of the range

Weights.TS

numeric 1-100 Assigns the weighting of the target strength

Weights.PingGap

numeric 1-100

MinimumTargets

numeric Minimum number of single targets to be considered a fish track

MinimumPings

numeric Maximum number of pings in a track

MaximumGap

numeric Maximum ping gap between tracks

References

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

Examples

## Not run: 
EVAppObj <- COMCreate('EchoviewCom.EvApplication')
EVFile <- EVOpenFile(EVAppObj,'~~/KAOS/KAOStemplate.EV')$EVFile
EVFishTracking(EVFile = EvFile,
EVVar = "Single target detection - wideband 1",
FishTrackRegionClass = "FishTracks",
MinimumTargets = 5,
export = "C:/FishTracking/Exports/FishTracks.csv")

## End(Not run)


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