rmoffset: Remove the offset of a time wave

Description

This function removes the offset of a time wave.

Usage

rmoffset(wave, f, channel = 1, FUN = mean, plot = FALSE, output = "matrix", ...)

Value

The offset is removed by substracting the wave by its mean (argument FUN). But other function can be used. For instance, it can be more approriate to use the median to remove the offtset and transients. See Examples.

If plot is FALSE, a new wave is returned. The class of the returned object is set with the argument output.

Arguments

wave: an R object.
f: sampling frequency of wave (in Hz). Does not need to be specified if embedded in wave.
channel: channel of the R object, by default left channel (1).
FUN: a function used to apply the offset correction. See Details.
plot: logical, if TRUE returns an oscillographic plot of the wave after removing the offset (by default FALSE).
output: character string, the class of the object to return, either "matrix", "Wave", "Sample", "audioSample" or "ts".
...: other oscillo graphical parameters.

Author

Jerome Sueur sueur@mnhn.fr

Examples

Run this code

data(tico)
# artifically generates an offset
tico2<-tico+0.1
# see the wave with an offset
oscillo(tico2, f=22050)
# remove the offset with the mean (by default)
rmoffset(tico2, f=22050, plot=TRUE)
# remove the offset with the median
rmoffset(tico2, f=22050, FUN=median, plot=TRUE)