set.path.vessel.cm: Wrapper for the method of drawing vessel positions based on...
In arnejohannesholmin/echoIBM: Simulation of multibeam sonar data

set.path.vessel.cm

R Documentation

Wrapper for the method of drawing vessel positions based on school centres of mass, given as an option to the fundtion echoIBM (specifying path=TRUE). set.path.vessel.cm() uses the function set.path.vessel() to select the vessel positions. The input variables in this function are especially selected for the single purpose of being used in echoIBM(), and are thus not user friendly for any othr use.

Description

Wrapper for the method of drawing vessel positions based on school centres of mass, given as an option to the fundtion echoIBM (specifying path=TRUE). set.path.vessel.cm() uses the function set.path.vessel() to select the vessel positions. The input variables in this function are especially selected for the single purpose of being used in echoIBM(), and are thus not user friendly for any othr use.

Usage

set.path.vessel.cm(
  schooldirs,
  dynschoolfiles,
  recycle,
  t,
  tvessel,
  numt,
  smooth,
  margin,
  scan.volume,
  beams,
  ctd,
  rph,
  event,
  eventname,
  pathnr
)

Arguments

`schooldirs`	is a vector of the directories of the schools to be simulated.
`dynschoolfiles`	is a list of the dynamic school files for the schools to be simulated.
`recycle`	see echoIBM(). Here, if 'recycle' is different from FALSE or does not contains zeros, the first time step is selected.
`t`	is the vector of the time steps for which to draw the vesse movement.
`tvessel`	is the UNIX time values to be written to the ".vessel" file. If tvessel==NULL the school time points are used.
`numt`	is the number of time steps for which to select vessel positions.
`smooth`	is the function used for smoothing the vessel path.
`margin`	is a vector of the margins on either side of the span of 'x' (recycled if not of length 4).
`scan.volume`	is TRUE if the acoustic observation volume schould be scanned for the positions of the fish.
`beams`	is a list of the beam configuration.
`ctd`	is a list of the CTD-specification of the sea.
`rph`	is a matrix of two columns of length 3 representing the mean (column 1) and the standard deviation (column 2) of the roll values (rtxv), pitch values (rtyv) and heave values (przv) of the vessel, used in gaussian simulation of the roll, pitch and heave values.
`event`	is a vector of strings representing the paths to the directories and files containing the necessary informtation for the simulation.
`eventname`	is the name of the main directory of the simulation, in which to store the simulate acoustical files.
`pathnr`	is the number of the vessel path drawn, to be used in the name of the ".vessel" file. If a new ".vessel" file is to be written, 'pathnr' must be different than the pathnr of existing files.