find_time_offset: Background function: find the time offset between Hyfe and a...

Description Usage Arguments Value

View source: R/utils_find_time_offset.R

Description

This function is never called directly by an analyst. It is used in synchronize() to determine offset corrections.

Usage

1
2
3
4
5
6
7
8
9
find_time_offset(
  reference_times,
  hyfe_times,
  offset_step,
  offset_range,
  plot_title = NULL,
  toplot = TRUE,
  verbose = TRUE
)

Arguments

reference_times

A vector of numeric timestamps (seconds since 00:00:00 UTC on January 1, 1970). These are the reference times to which the Hyfe detection times will be compared. For example, the timestamps of a labelled sound can serve as a reference time.

hyfe_times

A vector of numeric timestamps of Hyfe detections.

offset_step

The resolution of the offset estimation process; for example, if set to 60, the function will test various offsets at intervals of 60 seconds.

offset_range

The range of potential offsets to evaluate.

toplot

If TRUE, a diagnostic plot will be shown.

verbose

Print status updates to the Console?

Value

A best estimate of Hyfe's time offset, in seconds, from the reference times. The resolution/accuracy of this estimate will depend on the values chosen for offset_step.


hyfe-ai/hyfer documentation built on Dec. 20, 2021, 5:53 p.m.