track.line: Returns a list of x-values and y-values of points defined by...

In arnejohannesholmin/echoIBM: Simulation of multibeam sonar data

Returns a list of x-values and y-values of points defined by the fractions 'w' along the partial linear path defined by the points (x,y). Cumulative lengths of the path are also returned.

Description

Returns a list of x-values and y-values of points defined by the fractions 'w' along the partial linear path defined by the points (x,y). Cumulative lengths of the path are also returned.

Usage

track.line(
  x,
  y = NULL,
  w = NULL,
  dw = NULL,
  speed = NULL,
  start = NULL,
  alongx = FALSE,
  normalized = FALSE,
  list.out = TRUE,
  plot = FALSE,
  ...
)

Arguments

x	is the input x-variable.
y	is the input y-variable.
w	are the positions along the path (x,y). If 'w' is a single integer, it is set to seq(0,1,length.out=w). If 'speed' is given 'w' is interpreted as time values.
dw	are the piecewise lengths along the path (x,y), used only if w!=NULL. If 'dw' has length>1 it overrides 'w' by w=cumsum(dw).
speed	are the speed values along the path (x,y), or along the x-axis if alongx==TRUE. If given it overrides 'w'.
start	is a vector of two values representing the start point if 'x' and 'y' represent angles and lengths. If 'start' is given, 'x' and 'y' are interpreted as angles and lengths.
alongx	is TRUE if tracking is to be done along the x-axis, and not along the path (x,y).
normalized	is TRUE if the positions given by 'w' (and 'speed') are or should be normalized to [0,1], where 1 refers to the end of the path.
list.out	is TRUE if the output should be a data frame with the names "x", "y" and "l". Else a matrix with the same names is returned.
plot	is TRUE if a simple plot is to be drawn.
...	are parameters to be passed on to plot() if plot==TRUE.

arnejohannesholmin/echoIBM documentation built on April 14, 2024, 11:37 p.m.