ClipData: FUSION R command line interface - Clips subsamples of data...

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

FUSION R command line interface – Clips subsamples of data specified by the lower left and upper right corners of the area.

Description

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

Usage

ClipData(
  inputspecifier = NULL,
  samplefile = NULL,
  minx = "-1000000000",
  miny = "-1000000000",
  maxx = "1000000000",
  maxy = "1000000000",
  quiet = FALSE,
  verbose = FALSE,
  version = FALSE,
  newlog = FALSE,
  log = NULL,
  locale = FALSE,
  nolaszipdll = FALSE,
  skipfilecheck = FALSE,
  shape = 0,
  decimate = NULL,
  ground = NULL,
  zmin = NULL,
  zmax = NULL,
  zpercent = NULL,
  height = FALSE,
  timemin = NULL,
  timemax = NULL,
  anglemin = NULL,
  anglemax = NULL,
  zero = FALSE,
  biaselev = NULL,
  return = NULL,
  class = NULL,
  ignoreoverlap = FALSE,
  line = NULL,
  noindex = FALSE,
  index = FALSE,
  lda = FALSE,
  nooffset = FALSE,
  cleanlas = FALSE,
  precision = NULL,
  use64bit = TRUE,
  runCmd = TRUE,
  saveCmd = TRUE,
  cmdFile = NULL,
  cmdClear = FALSE,
  echoCmd = FALSE,
  comment = NULL
)

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 subsample file (extension will be added) or a text file containing sample information for 1 or more samples. Each line in the text file should have the output filename and the MinX MinY MaxX MaxY values for the sample area separated by spaces or commas. The output filename 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.
minx	numeric: X for lower left corner of the sample area bounding box.
miny	numeric: Y for lower left corner of the sample area bounding box.
maxx	numeric: X for upper right corner of the sample area bounding box.
maxy	numeric: Y for upper right corner of the sample area bounding box.
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).
nolaszipdll	boolean: Suppress the use of the LASzip dll (c) Martin Isenburg... removes support for compressed LAS (LAZ) files. This option is only useful for programs that read or write point files.
skipfilecheck	boolean: Skip logic that checks for valid point files and removes those that are invalid prior to the start of point processing. This option is designed to overcome some limitations with windows and wildcard processing. This option is only useful for programs that read point data.
shape	numeric: Shape of the sample area (0 = rectangle, 1 = circle).
decimate	numeric: Skip # points between included points (must be > 0).
ground	character: Use a surface file with /zmin to include points above zmin or with /zmax to include points below zmax. file may be wildcard or text list file (extension .txt only). file must be in FUSION/PLANS format.
zmin	numeric: Include points above # elevation..use with /dtm to include points above # height. Use with /height option to store heights in output file.
zmax	numeric: Include points below # elevation..use with /dtm to include points below # height. Use with /height option to store heights in output file.
zpercent	numeric: Include only the upper # percent of the points..if # is (-) only the lower # percent of the points..# = 0-100.
height	boolean: Convert point elevations into heights above ground using the specified DTM file..use with /dtm.
timemin	numeric: Include points with GPS times greater than # (LAS only).
timemax	numeric: Include points with GPS times less than or equal to # (LAS only). Interpretation of # depends on the GPS time recorded in the LAS point records.
anglemin	numeric: Include points with scan angles greater than # (LAS only).
anglemax	numeric: Include points with scan angles less than or equal to # (LAS only).
zero	boolean: Save subsample files that contain no data points.
biaselev	numeric: Add an elevation offset to every LIDAR point..# can be + or -.
return	character: "c,c,c,...": Specifies the returns to be included in the sample (can include A,1,2,3,4,5,6,7,8,9,F,L,O) Options are specified without commas (e.g. /return:123) For LAS files only: F indicates first and only returns, L indicates last of many returns.
class	character: "c,c,c,...": LAS files only: Specifies that only points with classification values listed are to be included in the subsample. Classification values should be separated by a comma. e.g. (2,3,4,5) and can range from 0 to 31. If the first character in string is ~, the list is interpreted as the classes you DO NOT want included in the subsample. e.g. /class:~2,3 would include all class values EXCEPT 2 and 3.
ignoreoverlap	boolean: Ignore points with the overlap flag set (LAS V1.4+ format).
line	numeric: LAS files only: Only include returns from the specified flight line. Line numbering varies by acquisition so you need to know your data to specify values for the flight line number.
noindex	boolean: Do not use the data index files to access the data files.
index	boolean: Create FUSION index files for the SampleFile.
lda	boolean: Write sample files using FUSION's LDA format when using LAS input files. The default behavior of ClipData (after version 2.35) is to write data in LAS format when the input data are in LAS format. When using input data in a format other than LAS, sample files are written in LDA format.
nooffset	boolean: Removes the offset value in the output LAS file making it difficult to pinpoint the location of the point cloud. This is typically used when the location of a sample cannot be known.
cleanlas	boolean: Only output points that adhere to the LAS format specification (valid GPS time, return # from 1 to 5, within header extent, points not flagged as withheld. Valid for LAS format input.
precision	character: "#,#,#": Control the scale factor used for X, Y, and Z values in output LAS files. These values will override the values in the source LAS files. There is rarely any need for the scale parameters to be smaller than 0.001.
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(), CloudMetrics(), Cover(), DTMDescribe(), DensityMetrics(), FilterData(), FirstLastReturn(), GridMetrics(), GridSample(), GridSurfaceCreate(), GridSurfaceStats(), GroundFilter(), IntensityImage(), JoinDB(), MergeDTM(), MergeData(), MergeRaster(), RepairGridDTM(), ReturnDensity(), SplitDTM(), SurfaceSample(), SurfaceStats(), TINSurfaceCreate(), ThinData(), TopoMetrics(), TreeSeg(), fusionwrapr-package

Examples

## Not run: 
ClipData("*.las", "clip1.las", ground = "small.dtm", height = TRUE)

## End(Not run)

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