envelope: Calculates the absolute amplitude envelope

View source: R/RcppExports.R

envelopeR Documentation

Calculates the absolute amplitude envelope

Description

Calculates the absolute amplitude envelope

Usage

envelope(x, ssmooth = 0)

Arguments

x

Numeric vector with amplitude values. Required.

ssmooth

Numeric vector of length 1 indicating the size of the sliding window use to smooth envelopes. Default is 0 (no smoothing).

Details

The function calculates the absolute amplitude envelope of an amplitude vector using compiled C code which is usually several times faster.

Value

An amplitude envelope.

Author(s)

Marcelo Araya-Salas (marcelo.araya@ucr.ac.cr) & Paula Monge

References

Araya-Salas, M., & Smith-Vidaurre, G. (2017). warbleR: An R package to streamline analysis of animal acoustic signals. Methods in Ecology and Evolution, 8(2), 184-191.

See Also

env.

Examples

{
data(tico)

amp_env <- envelope(tico@left, ssmooth = 100)
}

maRce10/warbleR documentation built on April 8, 2024, 11:08 p.m.