stan: (3D) space-time data animation

Description Usage Arguments Details Value Author(s)

View source: R/stan.R


Displays (x,y,t) point data and enables dynamic highlighting of time slices.





A 3-column matrix of x,y,t coordinates


A two-element vector of upper and lower time limits


The initial time window width


Whether to display points before time window


How to display points - see Details


A polygon to draw on the background plane


Whether to extend the bgpoly to the front plane


An list with x,y vectors and z matrix to display on the background plane


A colour palette vector with which to draw the bgimage


logical value indicating whether labels should be added.


This function requires the rpanel and rgl packages. It uses rpanel for the sliders to control the graphics, and rgl for its ability to do flicker-free graphics.

The sliders set the position and width of the temporal highlight window. For 'time' slider set to time T and 'width' slider set to W, highlighted points are those with time coordinate t such that T-W < t < T.

How points are shown is configured with the states parameter. This is a list of length 3 specifying how points before the time window, inside the time window, and after the time window are displayed. Each element is a list of parameters as would be passed to material3d() together with a radius element. Points are drawn as spheres with the corresponding material and radius as a fraction of the spatial span of the data.

By default the third state is invisible, and the first two states are different. By calling with the default for states and persist=TRUE, then the first state is set to the same as the second state. This has the effect of showing all points at time < T with the same sphere type.

If the user specifies the states parameter, then persist is ignored. The user can emulate the persist behaviour by specifying a states list with identical parameters for states 1 and 2.

Note that each state element should specify all material3d parameters used in any of the state elements. This is to make sure the parameters are reset for each of the sets of points.

The background polygon must be a simple 2-column vector of x and y coordinates. When used with bgframe=TRUE, the polygon is also drawn on the front plane, and the convex hull points are connected front to back in order to visualise the space-time prism that the data are contained in.

A raster image can be displayed on the back plane by setting the bgimage parameter. This must be a list with x, y and z components as needed by the image function. Note that x and y define the center of cells and so must be the same length as the dimensions of z - the image function can accept x and y values that are one longer than the dimensions of z to define the edges, but bgimage does not allow that.


A list of the slider parameters when the dialog is quitted.


Barry Rowlingson <>, Edith Gabriel

stpp documentation built on May 2, 2019, 4:50 p.m.