calculateICI: Calculate Inter-Click Interval

Description Usage Arguments Details Value Author(s)

Description

Calculate inter-click interval for click data

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
calculateICI(
  x,
  time = c("UTC", "peakTime"),
  callType = c("click", "whistle", "cepstrum"),
  ...
)

## S4 method for signature 'AcousticStudy'
calculateICI(
  x,
  time = c("UTC", "peakTime"),
  callType = c("click", "whistle", "cepstrum"),
  ...
)

## S4 method for signature 'AcousticEvent'
calculateICI(
  x,
  time = c("UTC", "peakTime"),
  callType = c("click", "whistle", "cepstrum"),
  ...
)

Arguments

x

a AcousticStudy object, a list of AcousticEvent objects, or a single AcousticEvent object

time

the time measurement to use. start will use the UTC value, peak will use the peakTime value if present (currently present in standardClickCalcs, this is the time of the peak of the waveform)

callType

the call type to calculate ICI for, usually this is click but also allows users to specify whistle or cepstrum to calculate this using other detector data

...

not used

Details

Calculates the ICI for each individual detector and across all detectors. ICI calculation is done by ordering all individual detections by time, then taking the difference between consecutive detections and taking the mode value.

Value

ICI data

Author(s)

Taiki Sakai taiki.sakai@noaa.gov


TaikiSan21/PAMr documentation built on Nov. 15, 2020, 9:46 p.m.