Template-class: Class '"Template"'

In jonkatz2/monitoR: Acoustic Template Detection in R

Class "Template"

Description

A template is an object with acoustic information (frequency, time, and amplitude) on an animal volcalization. Objects of class "corTemplate" are correlation templates, which contain quantitative data on amplitude. Objects of class "binTemplate" are binary templates, which contain only qualitative data on amplitude: only whether the it is high (“on” cells) or low (“off”) cells. The class "Template" is a virtual class, and both types of templates have this class. Templates are always stored as part of a TemplateList, either a corTemplateList or a binTemplateList.

Objects from the Class

Objects can be created by calls of the form new("corTemplate", ...) or new("binTemplate", ...). However, users should not work directly with objects of this class, but only with corTemplateList or binTemplateList, which can be created as described in the documentation for TemplateList.

Slots

clip.path:

Object of class character. The file path of the original recording used to create the template.

samp.rate:

Object of class integer. The sample rate of the recording.

pt.on:

Object of class matrix (binTemplate class only). A two-dimensional matrix with time (column 1) and frequency (column 2) bins for “on” points. Bin locations are relative to the first bin (“on” or “off”), which has a value of 1.

pt.off:

Object of class matrix (binTemplate class only). A two-dimensional matrix with time (column 1) and frequency (column 2) bins for “off” points. Bin locations are relative to the first bin (“on” or “off”), which has a value of 1.

pts:

Object of class "matrix" (corTemplate class only). A two-dimensional matrix with time (column 1) and frequency (column 2) bins, and amplitude (column 3).

t.step:

Object of class numeric. Time step between time bins (sec).

frq.step:

Object of class numeric. Frequency step between frequency bins (kHz).

n.t.bins:

Object of class integer. Total number of time bins in the template.

first.t.bin:

Object of class numeric. Time of the first time bin in the original recording (sec).

n.frq.bins:

Object of class integer. Total number of frequency bins.

duration:

Object of class numeric. Template duration (sec).

frq.lim:

Object of class numeric. Frequency limits (kHz).

wl:

Object of class integer. Value of argument wl used in the spectro function call when the template was created.

ovlp:

Object of class integer. Value of argument ovlp used in the spectro function call when the template was created.

wn:

Object of class character. Value of argument wn used in the spectro function call when the template was created.

score.cutoff:

Object of class numeric. The cutoff that will be used to identify detections when this template is used.

Extends

Classes corTemplate and binTemplate extend Template, directly.

Methods

No methods defined with these classes in the signature. But see TemplateList.

Author(s)

Sasha D. Hafner

See Also

binTemplateList, corTemplateList, TemplateList

Examples

showClass("Template")

showClass("corTemplate")

showClass("binTemplate")

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