templateScores-class: Class '"templateScores"'

In jonkatz2/monitoR: Acoustic Template Detection in R

Class "templateScores"

Description

These objects contain template scores, which indicate how well templates match a single survey recording, with a value for each time bin. Additionally, all the objects which were used to create these scores are also saved within the objects. Objects of this class represent an intermediate step in the template detection process–detections need to be found in the scores using findPeaks.

Objects from the Class

Objects can be created by calls of the form new("templateScores", ...). However, they should always be created with the corMatch or binMatch function.

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), 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.

time:

Object of class character. Information on the time corMatch or binMatch took to run. The first element is the run time (s), and the second element is “real-time factor” (survey length divided by the run time).

Methods

show

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

summary

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

Author(s)

Sasha D. Hafner

See Also

findPeaks, detectionList

Examples

showClass("templateScores")

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