ReturnDensity: FUSION R command line interface - Builds a raster data layer...

View source: R/ReturnDensity.R

ReturnDensityR Documentation

FUSION R command line interface – Builds a raster data layer containing the number of returns in each cell.

Description

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

Usage

ReturnDensity(
  outputfile = NULL,
  cellsize = NULL,
  datafile = NULL,
  quiet = FALSE,
  verbose = FALSE,
  version = FALSE,
  newlog = FALSE,
  log = NULL,
  locale = FALSE,
  nolaszipdll = FALSE,
  skipfilecheck = FALSE,
  first = FALSE,
  last = FALSE,
  only = FALSE,
  ascii = FALSE,
  nointpercentile = FALSE,
  projection = NULL,
  class = NULL,
  ignoreoverlap = FALSE,
  grid = NULL,
  gridxy = NULL,
  align = NULL,
  extent = NULL,
  datacoverage = FALSE,
  use64bit = TRUE,
  runCmd = TRUE,
  saveCmd = TRUE,
  cmdFile = NULL,
  cmdClear = FALSE,
  echoCmd = FALSE,
  comment = NULL
)

Arguments

outputfile

character (required): Name for the output raster file (stored in PLANS DTM format with .dtm extension). When ascii = TRUE, the output is stored in ASCII raster format

cellsize

numeric (required): Desired grid cell size in the same units as LIDAR data.

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.

first

boolean: Use first returns when computing return counts (default is all returns). Cannot be combined with /last or /only.

last

boolean: Use last returns when computing return counts (default is all returns). Only valid for LAS or LAZ format files. Cannot be combined with /first or /only.

only

boolean: Use last returns from pulses with only 1 return when computing return counts (default is allreturns). Only valid for LAS or LAZ format files. Cannot be combined with /first or /last.

ascii

boolean: Output raster data in ASCII raster format instead of PLANS DTM format. Output file extension will be .asc.

nointpercentile

boolean: Do not compute percentile values associated with first return intensity and output to CSV file. These values are useful to determine the range of values to scale intensity products.

projection

character: "filename": Associate the specified projection file with ASCII raster products.

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

grid

character: "X1,X2,Y1,Y2": Force the origin of the output grid to be (X,Y) instead of computing an origin from the data extents and force the grid to be W units wide and H units high...W and H will be rounded up to a multiple of cellsize.

gridxy

character: "X1,X2,Y1,Y2": Force the origin of the output grid to be (X1,Y1) instead of computing an origin from the data extents and force the grid to use (X2,Y2) as the upper right corner of the coverage area. The actual upper right corner will be adjusted to be a multiple of cellsize.

align

character: Force the origin and extent of the output grid to match the lower left corner and extent of the specified PLANS format DTM file.

extent

character: Force the origin and extent of the output grid to match the lower left corner and extent of the specified PLANS format DTM file but adjust the origin to be an even multiple of the cell size and the width and height to be multiples of the cell size.

datacoverage

boolean: Check for points within each cell in the output grid. Output a value of 1 if there are points covering the cell and a value of 0 if not.

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

Examples

## Not run: 
ReturnDensity("PointDensity.dtm", 10.0, "*.las")

## End(Not run)

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