srvy.dat {RSurvey} | R Documentation |
A function used to set or query survey parameters and data.
srvy.dat(option, value, clearAll = FALSE)
option |
the parameter name, described in the Survey Parameters section. |
value |
a parameter value specified for option . |
clearAll |
a logical; if TRUE all parameters are cleared from srvy.dat . |
The data frame data.raw
has the following components:
[,1] | numeric | date/time, "%Y-%m-%d %H:%M:%OS" (optional). |
[,2] | numeric | locations in the x-direction. |
[,3] | numeric | locations in the y-direction. |
[,4:] | numeric | state variables. |
The data frame data.mod
has the following components:
[,1] | x | numeric | locations in the x-direction. |
[,2] | y | numeric | locations in the y-direction. |
[,3] | z | numeric | state variable. |
The list data.tin
contains the following components:
x | numeric | locations in the x-direction. |
y | numeric | locations in the y-direction. |
z | matrix | rows and columns corresponding to grid lines in the x and y directions, respectively. |
cols | character | fields within the imported survey data, a concatenation of column type and units. |
csi | numeric | the height of plotted characters (in). |
data.file | character | the imported text file containing survey data. |
data.raw | data.frame | raw survey data, see Details section. |
data.mod | data.frame | processed survey data, see Details. |
data.tin | list | the interpolated surface derived from processed survey data, see Details. |
date.fmt | character | the date/time format for exported data, see srvy.export |
default.dir | character | the default directory for saving and opening files. |
depth | logical | if TRUE depths are converted to elevations during the interpolation. |
ed | character | end date |
eh | numeric | end hour |
em | numeric | end minute |
encoding | character | encoding to be assumed for input strings. Mark character strings as Latin-1 or UTF-8. |
es | numeric | end second |
font.gui | character | the GUI font, family and size. |
grad.tol | numeric | tolerance value for state variable correction. |
grid.res | numeric | the grid resolution for interpolation. |
max.vect | numeric | the maximum length for plotting velocity vector arrows. |
max.x | numeric | maximum x value |
max.y | numeric | maximum y value |
max.z | numeric | maximum z value |
min.x | numeric | minimum x value |
min.y | numeric | minimum y value |
n.levels | numeric | the approximate number of contour intervals. |
off.t | numeric | time offset in seconds. |
off.z | numeric | state variable offset |
poly | list | a polygon describing the spatial domain, class "gpc.poly" . |
poly.file | character | the imported polygon file. |
proj.file | character | the binary project file. |
projection | character | a description of the geographical projection in use. |
sd | character | start date |
sep | character | the field separator character. Values on each line of the file are separated by this character. |
sh | numeric | start hour |
sm | numeric | start minute |
ss | numeric | start second |
time.gap | numeric | the time gap exceedance level between sequential data records (sec). |
vars | character | field names corresponding to data/time, x, y, and z. |
ver | character | the version of RSurvey. |
win.loc | character | the default horizontal and vertical location for GUI placement (pixels). |
win.width | numeric | the default width for windows devices (in). |
wtr.elev | numeric | the water surface elevation. |
yx.ratio | numeric | the the y/x aspect ratio. |
zx.ratio | numeric | the the z/x aspect ratio. |
Fisher, J. C.
# To set a parameter srvy.dat("grad.tol", 0.01) srvy.dat("projection", "UTM") # To get a parameter value srvy.dat("grad.tol") # To get all parameter values srvy.dat() # To clear all parameters srvy.dat(clearAll = TRUE)