MergeDTM: FUSION R command line interface - Function to merge several...

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

FUSION R command line interface – Function to merge several .DTM files into a single file.

Description

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

Usage

MergeDTM(
  outputfile = NULL,
  inputfile = NULL,
  quiet = FALSE,
  verbose = FALSE,
  version = FALSE,
  newlog = FALSE,
  log = NULL,
  locale = FALSE,
  cellsize = NULL,
  overlap = NULL,
  disk = FALSE,
  precision = NULL,
  exactextent = FALSE,
  halfcell = FALSE,
  nofill = FALSE,
  use64bit = TRUE,
  runCmd = TRUE,
  saveCmd = TRUE,
  cmdFile = NULL,
  cmdClear = FALSE,
  echoCmd = FALSE,
  comment = NULL
)

Arguments

outputfile	character (required): Name for the output .DTM file containing the merged data.
inputfile	character (required): File name template for .DTM files to be merged or the name of a text file containing a list of .DTM files.
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).
cellsize	numeric: Resample the data using a # by # pixel.
overlap	character: Specify how overlap areas should be treated. Operators are: "average", "min", "max", "add", "new." The new operator populates a pixel using the value from the last .DTM file containing valid data for the pixel.
disk	boolean: Merge the .DTM files to a disk file. The default behavior is to try to hold the merged model into memory but there can be problems when there is not quite enough memory for the model.
precision	numeric: Override the default precision for the merged output file. The default behavior is to use the highest precision of the input models to establish the precision of the output model. Valid values for precision are: 0 2-byte integer 1 4-byte integer 2 4-byte floating point (C type: float) 3 8-byte floating point (C type: double)
exactextent	boolean: Preserve the exact extent of the input models in the output model. The default behavior is to expand the extent to the nearest multiple of the output cell size.
halfcell	boolean: Offset the origin and expand the width and height by 1/2 of the output cell size.
nofill	boolean: Do not fill holes in the merged DTM.
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(), MergeData(), MergeRaster(), RepairGridDTM(), ReturnDensity(), SplitDTM(), SurfaceSample(), SurfaceStats(), TINSurfaceCreate(), ThinData(), TopoMetrics(), TreeSeg(), fusionwrapr-package

Examples

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

## End(Not run)

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