detectionList-class: Class '"detectionList"'

In jonkatz2/monitoR: Acoustic Template Detection in R

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), and frq.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 (see Template).

templates:

Object of class list. A named list of templates, which is identical to the original TemplateList used for template matching. This template list can be extracted with getTemplates.

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), and score is the score. Times are based on the center of the template, and so time will not correspond to values in t.bins in the survey.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 the scores 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 the scores data frames (above) (but of course only contain those values that were identified as detections (i.e., peaks with a score above the score.cutoff).

Methods

show

signature(object = "detectionList"): ...

summary

signature(object = "detectionList"): ...

Author(s)

Sasha D. Hafner

See Also

findPeaks, getDetections, templateCutoff, templateScores

Examples

showClass("detectionList")

jonkatz2/monitoR documentation built on March 27, 2024, 4:39 p.m.