localizeSingle: Localize detected sounds

In mabecker89/solo: A Set of Tools for Sound Localization

Localize detected sounds

Description

localizeSingle is an internal function implemented within localizeMultipe. Its basic function is to take an index value corresponding to a detection, extract that detection, extract the relevant coordinates, and feed all relevant metadata into the 'localize()' function.

Usage

localizeSingle(
  st,
  index,
  plot = TRUE,
  InitData = NULL,
  keep.InitData = TRUE,
  keep.SearchMap = FALSE
)

Arguments

st	List. Localization settings object generated using processSettings.
index	Numeric. Index to be localized within a detection file.
plot	Logical. Whether to plot jpegs.
InitData	List. An InitData list created by running localization with keep.InitData = TRUE. Providing an InitData list saves computation time, but is only possible if the SearchGrid and stations used for localization remain unchanged. Default is NULL, which means the InitData will be calculated anew.
keep.InitData	Logical. Whether to store the InitData list.
keep.SearchMap	Logical. Whether to keep the SearchMap list with power estimates and coordinates of each grid cell. Should only be set to TRUE if the SearchMap is needed for some other reason (e.g. making a publication-ready figure or conducting more involved analysis with overlapping sources, etc.).

Value

List, containing the location of the sound source (global maximum), and optionally the InitData and SearchMap lists.

mabecker89/solo documentation built on March 1, 2023, 10:14 a.m.