ClipPlot: FUSION R command line interface - Super-function to clip data...

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

FUSION R command line interface – Super-function to clip data for plots using the ClipData program.

Description

ClipPlot creates command lines for the FUSION ClipData program and optionally executes them. Command lines are designed to clip a circular or square area centered in the (x,y).

Usage

ClipPlot(
  inputspecifier = NULL,
  samplefile = NULL,
  x = NULL,
  y = NULL,
  radius = NULL,
  shape = 1,
  ...
)

Arguments

inputspecifier	character (required): LIDAR data file template, name of a text file containing a list of file names (must have .txt extension), or a FUSION catalog file.
samplefile	character (required): Name for plot clip file (extension will be added). samplefile cannot contain spaces. To save compressed LAS files, specify the .laz extension. If the folder for the output file does not exist, it will be created when the function is called even when saving commands to a batch file.
x	numeric (required): Easting value for plot location.
y	numeric (required): Northing value for plot location.
radius	numeric (required): Radius for round (circular) plots or half width for square plots.
shape	numeric: default = 1: Shape of the sample area (0 = rectangle, 1 = circle).
...	Additional parameters that will be passed to ClipData.

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.

Examples

## Not run: 
ClipPlot("*.las", "plot_0001.las", 435895.9, 5669341.4, 0, ground = "small.dtm", height = TRUE)

## End(Not run)

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