seewave: oscilloST – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

oscilloST

Show a stereo time wave as oscillograms

Description

This graphical function displays a stereo (2 channels) time wave as an oscillogram in a two-frame plot. The envelope of the wave can also be shown.

Usage

oscilloST(wave1, wave2 = NULL, f, from = NULL, to = NULL,
fastdisp = FALSE,
identify = FALSE, plot = TRUE, colwave1 = "black",
colwave2 = "blue", coltitle = "black",
collab = "black", cexlab = 1, fontlab = 1, colaxis = "black",
cexaxis = 1, coly01 = "grey47", coly02 = "black", title = FALSE,
bty = "l")

Arguments

`wave1`	a first R object.
`wave2`	a second R object.
`f`	sampling frequency of `wave` (in Hz). Does not need to be specified if embedded in `wave`.
`from`	start of the oscillogram (in s).
`to`	end of the oscillogram (in s).
`fastdisp`	faster graphic display for long `wave`. The stereo oscillogram is displayed/saved faster in the graphic device/ graphic file when set to `TRUE`, with a cost on the graphic resolution.
`identify`	returns the time coordinate of points chosen with a cursor on the bottom oscillogram.
`plot`	logical, if `TRUE` returns an oscillographic or envelope plot of `wave`(by default `TRUE`).
`colwave1`	colour of the oscillogram or of the envelope of `wave1`.
`colwave2`	colour of the oscillogram or of the envelope of `wave2`.
`coltitle`	if `title` is `TRUE`, colour of the title.
`collab`	colour of axes title.
`cexlab`	character size for axes title.
`fontlab`	font for axes title.
`colaxis`	colour of the axes
`cexaxis`	mangification for axes annotation.
`coly01`	colour of the y=0 line of `wave1`.
`coly02`	colour of the y=0 line of `wave1`.
`title`	logical, if `TRUE` plots the title with information on time and `f` (by default `FALSE`).
`bty`	the type of box to be drawn around the oscillogram.

Value

Data are returned as two-column matrix if plot is FALSE. identify returns a numeric object with the time coordinate of points successively chosen on the bottom oscillogram.

Author(s)

Jerome Sueur and Caroline Simonis.

Examples

a<-synth(f=8000,d=1,cf=2000,am=c(50,10),plot=FALSE)
b<-synth(f=8000,d=1,cf=1000,fm=c(0,0,2000,0,0),plot=FALSE)
oscilloST(a,b,f=8000)

seewave

Sound Analysis and Synthesis

v2.1.6

GPL (>= 2)

Authors

Jerome Sueur <sueur@mnhn.fr> [cre, au], Thierry Aubin [au], Caroline Simonis [au], Laurent Lellouch [main ctrb], Ethan C. Brown [ctrb], Marion Depraetere [ctrb], Camille Desjonqueres [ctrb], Francois Fabianek [ctrb], Amandine Gasc [ctrb], Eric Kasten [ctrb], Stefanie LaZerte [ctrb], Jonathan Lees [ctrb], Jean Marchal [ctrb], Andre Mikulec [ctrb], Sandrine Pavoine [ctrb], David Pinaud [ctrb], Alicia Stotz [ctrb], Luis J. Villanueva-Rivera [ctrb], Zev Ross [ctrb], Carl G. Witthoft [ctrb], Hristo Zhivomirov [ctrb].

Initial release

2020-06-28