SurfaceStats: FUSION R command line interface - Computes surface area and...

In bmcgaughey1/fusionwrapr: R Interface to FUSION-LTK Command Line Programs

FUSION R command line interface – Computes surface area and volume for an entire surface.

Description

SurfaceStats creates command lines for the FUSION SurfaceStats program and optionally executes them.

Usage

SurfaceStats(
  inputfile = NULL,
  outputfile = NULL,
  quiet = FALSE,
  verbose = FALSE,
  version = FALSE,
  newlog = FALSE,
  log = NULL,
  locale = FALSE,
  ground = NULL,
  use64bit = TRUE,
  runCmd = TRUE,
  saveCmd = TRUE,
  cmdFile = NULL,
  cmdClear = FALSE,
  echoCmd = FALSE,
  comment = NULL
)

Arguments

inputfile	character (required): Name for the input DTM surface file.
outputfile	character (required): Name for the output CSV file containing the surface statistics.
quiet	boolean: Suppress all output during the run.
verbose	boolean: Display all status information during the run.
version	boolean: Report version information and exit with no processing.
newlog	boolean: Erase the existing log file and start a new log
log	character: Use the name specified for the log file.
locale	boolean: Adjust program logic to input and output locale-specific numeric formats (e.g. use a comma for the decimal separator).
ground	character: Use the specified surface model to represent the ground surface file may be wildcard or text list file (extension .txt only).
use64bit	boolean: indicates 64-bit version of the program should be used.
runCmd	boolean: indicates command line should be executed.
saveCmd	boolean: indicates command line should be written to a file.
cmdFile	character: contains the name of the file to which commands should be written.
cmdClear	boolean: indicates file for commands should be deleted (cleared) before the command line is written.
echoCmd	boolean: indicates command line should be displayed.
comment	character string containing comment to be written to command file before writing the actual command. Only used when runCmd = FALSE and saveCmd = TRUE. When written, there is always a blank line before the comment line in the command file.

Value

Return value depends on runCmd. if runCmd = TRUE, return value is the (invisible) integer value return from the operating system after running the command. if runCmd = FALSE, return value is the (invisible) command line.

Multiple Commands

LTKFunctions generate a separate command for each item when the required parameters are lists. This is useful when you want to use the same command and options but different input data and output files. However, this works only when the switches and options are the same for all commands (not lists). If you try to use a list of switches and/or options and a list of input files, you will produce commands using all sets of switches and/or options for every input file.

See Also

Other LTKFunctions: CSV2Grid(), CanopyMaxima(), CanopyModel(), Catalog(), ClipDTM(), ClipData(), CloudMetrics(), Cover(), DTMDescribe(), DensityMetrics(), FilterData(), FirstLastReturn(), GridMetrics(), GridSample(), GridSurfaceCreate(), GridSurfaceStats(), GroundFilter(), IntensityImage(), JoinDB(), MergeDTM(), MergeData(), MergeRaster(), RepairGridDTM(), ReturnDensity(), SplitDTM(), SurfaceSample(), TINSurfaceCreate(), ThinData(), TopoMetrics(), TreeSeg(), fusionwrapr-package

Examples

## Not run: 
SurfaceStats("merged_grnd.dtm", "*.dtm")

## End(Not run)

bmcgaughey1/fusionwrapr documentation built on Dec. 1, 2024, 7:13 a.m.