Cover: FUSION R command line interface - Computes cover estimates...

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

FUSION R command line interface – Computes cover estimates using a bare-earth surface model and point cloud.

Description

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

Usage

Cover(
  groundfile = NULL,
  coverfile = NULL,
  heightbreak = NULL,
  cellsize = NULL,
  xyunits = NULL,
  zunits = NULL,
  coordsys = NULL,
  zone = NULL,
  horizdatum = NULL,
  vertdatum = NULL,
  datafile = NULL,
  quiet = FALSE,
  verbose = FALSE,
  version = FALSE,
  newlog = FALSE,
  log = NULL,
  locale = FALSE,
  nolaszipdll = FALSE,
  skipfilecheck = FALSE,
  all = FALSE,
  class = NULL,
  ignoreoverlap = FALSE,
  penetration = FALSE,
  upper = NULL,
  runCmd = TRUE,
  saveCmd = TRUE,
  cmdFile = NULL,
  cmdClear = FALSE,
  echoCmd = FALSE,
  comment = NULL
)

Arguments

groundfile	character (required): Name of the bare-earth surface model used to normalize LIDAR data groundfile may be wildcard or text list file (extension .txt).
coverfile	character (required): Name for output canopy cover file (stored in PLANS DTM format with .dtm 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.
heightbreak	numeric (required): Height break for cover layer...base of desired layer.
cellsize	numeric (required): Desired grid cell size in the same units as LIDAR data.
xyunits	character (required): Units for LIDAR data XY (M for meters, F for feet, O for other or unknown).
zunits	character (required): Units for LIDAR data elevations (M for meters, F for feet, O for other or unknown).
coordsys	numeric (required): Coordinate system for LIDAR data: 0 for unknown 1 for UTM 2 for state plane)
zone	numeric (required): Coordinate system zone for LIDAR data (0 for unknown).
horizdatum	numeric (required): Horizontal datum: 0 for unknown 1 for NAD27 2 for NAD83
vertdatum	numeric (required): Vertical datum: 0 for unknown 1 for NGVD29 2 for NAVD88 3 for GRS80
datafile	character (required): Name(s) of lidar data 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).
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.
all	boolean: Use all returns when computing percent cover (default is first returns only).
class	character: "#,#,#,...": 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).
penetration	boolean: Compute proportion of returns close to ground surface (returns within +-heightbreak units).
upper	numeric: Use an upper limit when computing the cover value. This allows for calculation of the proportion of returns between a lower and upper height/elevation range.
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(), 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: 
Cover("ground.dtm", "cancover.dtm", 6.0, 2.0, "M", "M", 1, 10, 2, 2, "pts.las", class = "~7")

## End(Not run)

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