GridSurfaceStats: 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 the surface. Result is a raster layer.

Description

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

Usage

GridSurfaceStats(
  inputfile = NULL,
  outputfile = NULL,
  samplefactor = NULL,
  quiet = FALSE,
  verbose = FALSE,
  version = FALSE,
  newlog = FALSE,
  log = NULL,
  locale = FALSE,
  ground = NULL,
  ascii = FALSE,
  area = FALSE,
  halfcell = NULL,
  svonly = FALSE,
  grid = NULL,
  gridxy = NULL,
  align = NULL,
  extent = NULL,
  use64bit = TRUE,
  runCmd = TRUE,
  saveCmd = TRUE,
  cmdFile = NULL,
  cmdClear = FALSE,
  echoCmd = FALSE,
  comment = NULL
)

Arguments

inputfile	character (required): File specifier for the input surface file. This can be a single file, a wildcard specifier, or a text list file (extension .txt only).
outputfile	character (required): Base name for the output files containing the surface statistics including the .dtm extension. If ascii=TRUE, the output files will all be in ASCII raster format with the .asc extension.
samplefactor	numeric (required): Multiplier for outputfile cell size. outputfile cells will represent samplefactor * samplefactor cells from the inputfile. When multiple input files are used, the cell size of the first file is used to compute the outfile cell size.
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: "file": Use the specified surface model to represent the ground surface file may be wildcard or text list file (extension .txt only).
ascii	boolean: Output all files in ASCII raster format with the .asc extension.
area	boolean: Compute the surface area of inputfile instead of the surface area divided by the flat cell area.
halfcell	boolean: Force alignment of the output grid to match the grid used by the GridMetrics progam. This option cannot be used with grid, gridxy, extent, or align switches.
svonly	boolean: Output only the surface volume metric layer.
grid	character: "X1,X2,Y1,Y2": Force the origin of the output grid to be (X,Y) instead of computing an origin from the data extents and force the grid to be W units wide and H units high...W and H will be rounded up to a multiple of cellsize.
gridxy	character: "X1,X2,Y1,Y2": Force the origin of the output grid to be (X1,Y1) instead of computing an origin from the data extents and force the grid to use (X2,Y2) as the upper right corner of the coverage area. The actual upper right corner will be adjusted to be a multiple of cellsize.
align	character: Force the origin and extent of the output grid to match the lower left corner and extent of the specified PLANS format DTM file.
extent	character: Force the origin and extent of the output grid to match the lower left corner and extent of the specified PLANS format DTM file but adjust the origin to be an even multiple of the cell size and the width and height to be multiples of the cell size.
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(), GroundFilter(), IntensityImage(), JoinDB(), MergeDTM(), MergeData(), MergeRaster(), RepairGridDTM(), ReturnDensity(), SplitDTM(), SurfaceSample(), SurfaceStats(), TINSurfaceCreate(), ThinData(), TopoMetrics(), TreeSeg(), fusionwrapr-package

Examples

## Not run: 
GridSurfaceStats("ground.dtm", 30.0, 4.0, "density.csv", "*.las")

## End(Not run)

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