filterEchoDepths {PAMpal}

Filter Candidate Echo Depths

Description

Filter out possible echo depths from calculateEchoDepth based on maximum depth, autocorrelation magnitude, and maximum swim speed criteria. Requires that calculateEchoDepth has been run first. This function adds a keepClick column to the data to track which detections should be used for further depth analysis by marking them as FALSE to be excluded or TRUE to be used

Usage

filterEchoDepths(
  x,
  time = 30,
  depth = NULL,
  speed = NULL,
  maxDepth = 4000,
  minCorr = 0.01
)

Arguments

x

an AcousticStudy object that has been processed with calculateEchoDepth

time

maximum time apart (seconds) for detections. Detections with no no other detection within time seconds will be marked as FALSE

depth

maximum depth difference (meters) between consecutive clicks, this value should be determined by maximum swim speed

speed

as an alternative to providing depth, the swim speed (meters / second) can be provided and then depth will be calculated as time * speed

maxDepth

calculated depth values greater than this will be marked FALSE

minCorr

detections with autocorrelation magnitude less than this will be marked as FALSE

Value

the AcousticStudy x with detections marked with column keepClick as TRUE or FALSE depending if they pass the filter parameters

Author(s)

Taiki Sakai [e-mail]

Examples

# example not run because \link{calculateEchoDepth} must be run first,
# and it requires a large amount of data not stored in the package
## Not run: 
study <- calculateEchoDepth(study, wav='path/to/wavFiles')
study <- filterEchoDepths(study, time=30, speed=50/30, maxDepth=4000)

## End(Not run)