set.path.vessel: Interactive function for selecting the path and speed of an...

In arnejohannesholmin/echoIBM: Simulation of multibeam sonar data

Interactive function for selecting the path and speed of an object based on reference points 'x', intended for use in echoIBM().

Description

Interactive function for selecting the path and speed of an object based on reference points 'x', intended for use in echoIBM().

Usage

set.path.vessel(
  x,
  n = nrow(x),
  t = NULL,
  ref = NULL,
  maxspeed = 15,
  margin = 500,
  maxn = 100,
  path.col = "blue",
  grid = TRUE,
  smooth = "spline"
)

Arguments

x	are the reference points.
n	and 't' are the numbers of points and the times for the points along the path respectively. The combination of 'n' and 't', and whether the user selects speed values interactively, defines the mode of the output. There are 7 modes of the output, as liste below (lt=length(t)):
ref	is a list of reference information from a previous set.path.vessel session (given as the output from set.path.vessel()). The points of ref will be plotted in grey, to form a visual reference for the user.
margin	is a vector of the margins on either side of the span of 'x' (recycled if not of length 4).
maxn	maximum number of points entered (to prevent "getting stuck" in the function).
path.col	color of the entered path.
grid	is TRUE if a 100 meter grid is to be plotted.
smooth	has one possible value "spline", smooths the x-values and the y-values of the path separately using the spline function.

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