detectionList-class {monitoR} | R Documentation |
Class "detectionList"
Description
These objects contain information on template detections, as well as (almost) all the information contained in templateScores
These objects represent the final result of the template detection process.
Various functions exist for working with these objects.
Information on the detections alone can be extracted with getDetections
.
Objects from the Class
Objects can be created by calls of the form new("detectionList", ...)
.
However, these objects should always be created by applying the findPeaks
to templateScores
objects.
There are other functions the exist for modifying existing detectionList
objects, including showPeaks
, and the combination of templateCutoff
and findDetections
.
Slots
survey.name
:Object of class
"character"
. The name of the survey file, or"A Wave object"
if the survey was not read in from a file.survey
:Object of class
Wave
. The survey data, as a"Wave"
object.survey.data
:Object of class
list
. A named list, with one element for each template. Each element contains data from a Fourier transform of the original survey:amp
is a matrix of amplitudes (frequency by time, r by column),t.bins
is a numeric vector with the values of the time bins (left-aligned–first bin is always 0.0), andfrq.bins
is a numeric vector with the values of the frequency bins (top-aligned–last bin is always the upper limit). There is a separate element for each template because each template may use different parameters for the Fourier transform (seeTemplate
).templates
:Object of class
list
. A named list of templates, which is identical to the originalTemplateList
used for template matching. This template list can be extracted withgetTemplates
.scores
:Object of class
list
. A named list, with one element for each template. Each element is a data frame with three columns:date.time
is the absolute time of the score,time
is the relative time of the score (relative to the survey start), andscore
is the score. Times are based on the center of the template, and sotime
will not correspond to values int.bins
in thesurvey.data
above if the template spans an even number of time bins.peaks
:Object of class
list
. A named list, with one element for each template. Each element is a data frame that contains information on peaks that were found. The first three columns are identical to those in thescores
data frames (above) (but of course only contain those values that were identified as peaks). The fourth column is logical and indicates whether the peak was also a detection.detections
:Object of class
list
. A named list, with one element for each template. Each element is a data frame that contains information on detections. The columns are identical to those in thescores
data frames (above) (but of course only contain those values that were identified as detections (i.e., peaks with a score above thescore.cutoff
).
Methods
- show
signature(object = "detectionList")
: ...- summary
signature(object = "detectionList")
: ...
Author(s)
Sasha D. Hafner
See Also
findPeaks
,
getDetections
,
templateCutoff
,
templateScores
Examples
showClass("detectionList")