SplitDTM: FUSION R command line interface - Splits a DTM into separate...

View source: R/SplitDTM.R

SplitDTMR Documentation

FUSION R command line interface – Splits a DTM into separate tiles.

Description

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

Usage

SplitDTM(
  inputdtm = NULL,
  outputdtm = NULL,
  columns = NULL,
  rows = NULL,
  quiet = FALSE,
  verbose = FALSE,
  version = FALSE,
  newlog = FALSE,
  log = NULL,
  locale = FALSE,
  maxcells = NULL,
  use64bit = TRUE,
  runCmd = TRUE,
  saveCmd = TRUE,
  cmdFile = NULL,
  cmdClear = FALSE,
  echoCmd = FALSE,
  comment = NULL
)

Arguments

inputdtm

character (required): Name of the existing PLANS format DTM file to be subdivided.

outputdtm

character (required): Base name for the new PLANS format DTM tiles. The actual tile name will have the column and row numbers appended to it.

columns

numeric (required): Number of columns of tiles.

rows

numeric (required): Number of rows of tiles.

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).

maxcells

numeric: Maximum number of cells in the output tiles. Columns and Rows are ignored (but values are needed on the command line). New values for Columns and Rows will be calculated. The default maximum number of cells is 25,000,000.

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(), SurfaceSample(), SurfaceStats(), TINSurfaceCreate(), ThinData(), TopoMetrics(), TreeSeg(), fusionwrapr-package

Examples

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

## End(Not run)

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