riv2Bathy: riv2Bathy
In RiverSurvey: River Research and Modelling

Description Usage Arguments Details Value Note Author(s) See Also

This function creates point layers of bathymetry based on RiverSurveyor ADCP data and, optionally, external GNSS data.

riv2Bathy(path = getwd(), externalGPS = NULL, TimeShiftSecs = 0,
  plane = NULL, z.out = "Elevation", out = "all", outdir = ".",
  outfile = NULL, fileAppendix = "", verbose = TRUE, plot = TRUE,
  map = TRUE)

`path`	the path to the input files (default = working directory.) Automatically handles batch processing if path is a directory.
`externalGPS`	`GNSS` if external GNSS data is to be used for computing point locations (default = NULL)
`TimeShiftSecs`	Optional: an integer as the number of seconds to shift GNSS data, if not in UTC (default = 0)
`plane`	Optional: a dataFrame output by `addPlane.z()`. (default = NULL)
`z.out`	Z coordinate of output file. Takes one of three strings as values: "Elevation", "plane.z", "bed.z" (default = "Elevation")
`out`	Output filetype. can take either of these strings as values: "csv", "shape", "all" (default), "none"
`outdir`	target directory for output files (default = ".")
`outfile`	Optional: a string as the file name base for output files
`fileAppendix`	a string appendix to file name
`verbose`	logical, prints the first 100 lines of the result to screen (default =TRUE)
`plot`	logical, plots the points created. (default = TRUE)
`map`	logical , creates a PDF-map of the bathymetry data points (default = TRUE)

Bathymetry is created as depth and bed elevation. Surface elevation is also included for post-processing purposes)

A spatialPointsDataFrame, or, a file containing 3D point data (XYZ) either as CSV, ESRI shape, or both (default). The flow and depth data, as well as a bunch of other variables from the ADCP are included to be used as attributes / scalar fields.

path: If you provide a full path to a RiverSurveyor *.mat file, that file will be used for processing and only the relevant GNSS points form the external GNSS file (if applicable) will be used. If your measurement is split over several *.mat files, put them all in the same directory and input the path to the directory instead of a file. The function will batch-process all *.mat files in that directory and combine the resulting points into one output file.

If plane is provided, this adds theoretical surface elevations based on plane equation: surface.z and bed.z based on surface.z

if out == "none", no output file is created but the spatialPointsDataFrame is returned on exit; all other options produce output files but return empty.

outfile defaults to NULL, meaning that the file name of the output file is automatically created form the first ADCP *.mat file used for input.

fileAppendix is intended to be used together with automatic file names (outfile == NULL) to allow customisation of file names while retaining the convenience of automatically generated file names

Claude Flener claude.flener@utu.fi

addPlane.z

RiverSurvey documentation built on May 2, 2019, 5:46 p.m.