quantplot: Plotting the quantization of a melody

View source: R/quantplot.R

quantplotR Documentation

Plotting the quantization of a melody

Description

Plot an observed melody and (optional) an expected melody, as well as corresponding energy values (corresponding to the loudness of the sound) within a quantization grid.

Usage

quantplot(observed, energy = NULL, expected = NULL, bars, 
    barseg = round(length(observed) / bars), 
    main = NULL, xlab = NULL, ylab = "note", xlim = NULL, ylim = NULL, 
    observedcol = "red", expectedcol = "grey", gridcol = "grey",
    lwd = 2, las = 1, cex.axis = 0.9, mar = c(5, 4, 4, 4) + 0.1,
    notenames = NULL, silence = "silence", plotenergy = TRUE, ...,
    axispar = list(ax1 = list(side=1), ax2 = list(side=2), ax4 = list(side=4)),
    boxpar = list(), 
    energylabel = list(text="energy", side=4, line=2.5, at=rg.s-0.25, las=3),
    energypar = list(pch=20), 
    expectedpar = list(),
    gridpar = list(gridbar = list(col = 1), gridinner = list(col=gridcol)),
    observedpar = list(col=observedcol, pch=15))

Arguments

observed

Either a vector of observed notes resulting from some quantization, or a list with components notes (observed notes) and energy (corresponding energy values), e.g. the result from a call to quantize.

energy

A vector of energy values with same quantization as observed (overwrites any given energy values if observed is a list).

expected

Expected notes (optional; in order to compare results).

bars

Number of bars to be plotted (e.g. corresponding to quantize arguments).

barseg

Number of segments (minimal length notes) in each bar.

main

Main title of the plot.

xlab, ylab

Annotation of x-/y-axes.

xlim, ylim

Range of x-/y-axis.

observedcol

Colour for the observed notes.

expectedcol

Colour for the expected notes.

gridcol

Colour of the inner-bar grid.

lwd

Line width, see par for details.

las

Orientation of axis labels, see par for details.

cex.axis

Size of tick mark labels, see par for details.

mar

Margins of the plot, see par for details.

notenames

Optionally specify other notenames (character) for the y-axis.

silence

Character string for label of the ‘silence’ (default) axis.

plotenergy

Logical indicating whether to plot energy values in the bottom part of the plot (default is TRUE) if energy values are specified, and FALSE otherwise.

...

Additional graphical parameters to be passed to underlying plot function.

axispar

A named list of three other lists (ax1, ax2, and ax4) containing parameters passed to the corresponding axis calls for the three axis time (ax1), notes (ax2), and energy (ax4).

boxpar

A list of parameters to be passed to the box generating functions.

energylabel

A list of parameters to be passed to the energy-label generating mtext call.

energypar

A list of parameters to be passed to the points function that draws the energy values.

expectedpar

A list of parameters to be passed to the rect function that draws the rectangles for expected values.

gridpar

A named list of two other lists (gridbar and gridinner) containing parameters passed to the abline functions that draw the grid lines (for bar separators and inner bar (note) separators).

observedpar

A list of parameters to be passed to the lines function that draws the observed values.

Author(s)

Uwe Ligges ligges@statistik.tu-dortmund.de

See Also

noteFromFF, FF, melodyplot, quantize; for an example, see the help in tuneR.


tuneR documentation built on May 29, 2024, 11:28 a.m.

Related to quantplot in tuneR...